Integration API¶
Use the API reference to integrate messaging, document generation, and contact lists with your systems.
Before you begin¶
Obtain the credentials provided by Ofimatic and identify the service you will call. Credentials and authentication headers differ by API; use the header shown in the corresponding endpoint guide.
| Operation | Guide | Authentication documented |
|---|---|---|
| Send SMS, Email, or Voice; check SMS/Email status | SMS, Email, Voice, Check status | X-Api-Key: {{API_KEY}} |
| Send WhatsApp | Authorization: {{API_KEY}} | |
| Manage contact lists | Contact list | Authorization: Bearer {{JWT_TOKEN}} |
| Manage OPG templates or query documents | OPG | Authorization: Bearer {{JWT_TOKEN}} |
| Generate a PDF | Generate document | X-Api-Key: {{API_KEY}} |
Authentication¶
For endpoints using an API key, replace {{API_KEY}} with your assigned credential:
POST https://send.obmessage.ai/api/v1/{service}
X-Api-Key: {{API_KEY}}
Content-Type: application/json
Replace {service} with the endpoint from the channel guide. Do not use this generic example to override the authentication header documented for WhatsApp, contact lists, or OPG.
Make a first request¶
- Open the guide for the operation.
- Prepare the documented method, URL, authentication header, and content type.
- Replace sample identifiers, destinations, and data with values for your integration.
- If using
not_sent_after, provide an appropriate future UTC timestamp; dates in examples are illustrative. - Submit the request and inspect both the HTTP response and returned status.
- Retain the returned identifier for follow-up queries.
Message acceptance does not by itself confirm delivery. Use Check status for SMS and Email, or Activities for operational follow-up.
For unsuccessful requests, see Error responses.