Esendex API

Introducción

La nueva API (Application Programming Interface, Interfaz de programación de aplicaciones) es sencilla, ligera y está diseñada a partir de estándares simples y establecidos que reducen la necesidad de kits de herramientas especiales. Esto permite a Esendex ofrecer sistemas compatibles con una mayor variedad de lenguajes de programación con una sencillez nunca vista hasta ahora.

El documento de apoyo describe el enfoque "RESTful" que la API ofrece a los servicios de mensajería para empresas proporcionados por Esendex. Está concebido para proporcionar toda la información necesaria para comenzar a utilizar la API.

Documentación de la API de Esendex 

La API de Esendex se ha basado en el estilo arquitectónico REST y se ha implementado sobre el protocolo HTTP. Utiliza los métodos HTTP estándar de GET, POST, PUT y DELETE para interactuar con un conjunto de recursos definidos. Las solicitudes realizadas a la REST API y las respuestas obtenidas de la misma son representaciones XML con codificación UTF-8.
Para poder utilizar la Esendex API se requiere lo siguiente:

• Una conexión a Internet activa
• Tratamiento de objetos de Solicitud / Respuesta de HTTP
• Funcionalidad de análisis XML

Métodos de HTTP

Existen cuatro métodos o verbos principales de HTTP que se utilizan para interactuar con la API de Esendex. Éstos son GET, POST, PUT y DELETE.

El uso de estos verbos describe las operaciones sobre un recurso del modo siguiente:

• GET
  • Recupera una representación del recurso solicitado (estado actual)
• POST
  • Crea una instancia nueva de un recurso
• PUT
  • Actualiza una instancia existente de un recurso
• DELETE
  • Elimina una instancia existente de un recurso

Inicio rápido

Aquí se presentan las dos tareas básicas de enviar y recibir mensajes para ayudar a identificar rápidamente los Recursos necesarios para llevar a cabo estas operaciones clave.

Utilización de la API de Esendex

Cada interacción con la API de Esendex requiere los mismos pasos básicos:

1. Recoger cualquier dato necesario para efectuar la solicitud.
2. Elaborar una Solicitud de HTTP. Asegurarse de incluir el encabezado de Autenticación y cualquier parámetro de datos adicional.
3. Invocar la solicitud de HTTP al URI de recursos apropiado empleando un método de HTTP admitido.
4. Recuperar la Respuesta de HTTP y analizarla.
5. Si fuera apropiado, utilizar los datos de respuesta para continuar realizando otras operaciones.

Envío de mensajes

Para enviar mensajes, necesitarás utilizar el recurso de Distribución de mensajes. A cada mensaje que se envíe satisfactoriamente a través de Esendex se le asignará un valor de GUID (Globally Unique Identifier, Identificador único a nivel global) único. Dicho ID podrá utilizarse para recuperar los detalles del mensaje a posteriori, incluyendo su estado de entrega, a través del recurso Encabezados de mensajes.

Recepción de mensajes

Para recibir mensajes, podrás o bien "obtener" (recuperar) los mensajes desde el recurso de Bandeja de entrada o bien hacer uso del mecanismo de notificación de transmisión Administrador de eventos de cuenta.

Por ejemplo, la recuperación de los mensajes de tu bandeja de entrada es tan sencilla como realizar una solicitud GET a http://api.esendex.com/v1.0/inbox/messages