API de integración¶
Utilice la referencia de API para integrar mensajería, generación de documentos y listas de contactos con sus sistemas.
Antes de comenzar¶
Obtenga las credenciales proporcionadas por Ofimatic e identifique el servicio que utilizará. Las credenciales y los encabezados de autenticación varían según la API; utilice el encabezado indicado en la guía del endpoint correspondiente.
| Operación | Guía | Autenticación documentada |
|---|---|---|
| Enviar SMS, Email o Voz; consultar estados de SMS/Email | SMS, Email, Voz, Consultar estado | X-Api-Key: {{API_KEY}} |
| Enviar WhatsApp | Authorization: {{API_KEY}} | |
| Administrar listas de contactos | Lista de contactos | Authorization: Bearer {{JWT_TOKEN}} |
| Administrar plantillas OPG o consultar documentos | OPG | Authorization: Bearer {{JWT_TOKEN}} |
| Generar un PDF | Generar documento | X-Api-Key: {{API_KEY}} |
Autenticación¶
Para los endpoints que utilizan una llave de API, sustituya {{API_KEY}} por la credencial asignada:
POST https://send.obmessage.ai/api/v1/{service}
X-Api-Key: {{API_KEY}}
Content-Type: application/json
Sustituya {service} por el endpoint de la guía del canal. No utilice este ejemplo genérico para reemplazar el encabezado documentado para WhatsApp, listas de contactos u OPG.
Realizar una primera solicitud¶
- Abra la guía de la operación.
- Prepare el método, la URL, el encabezado de autenticación y el tipo de contenido indicados.
- Sustituya los identificadores, destinatarios y datos de ejemplo por valores de su integración.
- Si utiliza
not_sent_after, indique una fecha futura adecuada en UTC; las fechas de los ejemplos son ilustrativas. - Ejecute la solicitud y revise tanto la respuesta HTTP como el estado retornado.
- Conserve el identificador recibido para consultas posteriores.
La aceptación de un mensaje no confirma por sí sola su entrega. Utilice Consultar estado para SMS y Email, o Actividades para el seguimiento operativo.
Ante una solicitud fallida, consulte Respuestas de error.