Para qué se necesita la API

API (Application Programming Interface) — es una funcionalidad para la interacción entre distintos programas. Para las personas existen interfaces separadas, por ejemplo un sitio. La API se necesita para diversas integraciones. Sender Solutions tiene una API que funciona mediante solicitudes HTTP en formato JSON. El acceso a la API se proporciona para todos los planes tarifarios del proyecto, incluido el plan tarifario gratuito. Puede usar la API de Sender Solutions para una integración más completa y flexible. El formato previsto de uso de la API — desde su sitio sobre la base de disparadores. Por ejemplo, cuando en su sitio se crea un suscriptor, el sitio realiza una solicitud a la API, y un suscriptor con los mismos datos se crea en Sender Solutions.

Inicio del uso de la API

1. Para usar la API, necesita crear un proyecto en la Cuenta personal de Sender Solutions.
2. A continuación, en la página de configuración del proyecto, cree una clave API. Es una clave de acceso única a la API a nivel de este proyecto. Consérvela en secreto. Si hay sospecha de que la clave ha sido comprometida, empiece a usar una nueva clave lo antes posible, y desactive o elimine la clave comprometida.
3. Para un mismo proyecto se pueden crear varias claves API — todas son equivalentes. Esto puede ser útil si tiene varias aplicaciones distintas que realizarán solicitudes a la API.
4. La clave API debe transmitirse en el encabezado HTTP Authorization.
5. Transmita el cuerpo de la solicitud en formato JSON, y en el encabezado Content-Type indique el valor application/json.
6. Oriéntese por el estado HTTP de la respuesta. Si el código es 200 — todo se realizó con éxito. Si el código es 500 — se produjo un error.
7. La respuesta de la API, en general, se devuelve en formato JSON. En el nivel raíz está presente la clave "success" con los posibles valores true / false.
   Ejemplo de respuesta exitosa:
   {
    "success": true
}
   
   Ejemplo de respuesta con error:
   {
    "error": "Some error description",
    "success": false
}
   En el cuerpo de una respuesta exitosa puede haber datos adicionales según la solicitud concreta.
8. Para trabajar con la API no se necesita soporte de cookies ni de sesiones.

Recursos útiles

Composer paquete para trabajar con la API en php: sender-solutions/php-sdk y el mismo paquete en github: Sender-Solutions/php-sdk

Postman la colección de solicitudes a la API está disponible en el enlace