Portal para desarrolladores

Introducción

El objetivo de Esendex es hacer que nuestras API sean accesibles y facilitar el envío y la recepción de mensajes. En esta página, presentaremos una breve introducción a las API, pero para obtener más información sobre ellas, visita el Portal para desarrolladores.

Mira el vídeo a continuación para obtener una descripción general del portal para desarrolladores.

Video

¿Qué es una API?

Una API, o Interfaz de Programación de Aplicaciones, conecta tu aplicación con otros servicios o fuentes de datos. Al realizar una llamada a la API, solicitas datos, la API los obtiene y te envía una respuesta. Para ello, solo necesitas usar un método HTTP para realizar la solicitud.

Imagina cuando pides comida en un restaurante. Le dices al camarero lo que quieres, este pasa tu pedido al chef y luego el camarero regresa con la comida. Una llamada a la API funciona de la misma manera.

Las API tienen dos propósitos principales:

Establecimiento de reglas: Las API explican cómo interactuar con ellas. Establecen las reglas para los desarrolladores.
Transferencia de datos: Transfieren datos entre la aplicación y el servidor de forma eficiente. Esto garantiza que recibas los datos que necesitas.

Endpoint de API

Un Endpoint de API es una URL específica que permite acceder a un recurso en el servidor. Es el punto de comunicación entre un cliente y un servidor de API, donde se reciben las solicitudes y se envían las respuestas.

Cada punto final se compone de:

Una URL de punto final
- Una URL base (esta permanece fija, p. ej., https://conversations.esendex.co.uk)
- La ruta del punto final: aquí puedes añadir parámetros configurables que afectan la respuesta y actúan como filtros para tu búsqueda

Un método HTTP
Encabezados
Un cuerpo

Rest API

Nuestras API utilizan una estructura REST (Transferencia de Estado Representacional), también conocida como API RESTful. Esto significa que funcionan en línea. Al realizar una solicitud a una API REST, se obtienen todos los datos disponibles.

Cheat sheet

Antes de comenzar, aquí hay algunos términos de API que debes conocer:

Término	Definición
Clave API	Un código de acceso único de letras y números que otorga acceso a una API.
Punto final	La ubicación o ruta digital donde una API recibe solicitudes sobre sus recursos.
Método de solicitud	Utiliza métodos HTTP (GET, POST, PUT, DELETE) para indicar a la API lo que se desea que haga.
Llamada API	Proceso por el cual un cliente realiza una solicitud API a un servidor.
Código de estado	Un código numérico que aparece en el cuerpo de una respuesta API y que le indica si su solicitud fue exitosa o no.
Servidor API	Autentica y procesa las solicitudes API antes de entregar una respuesta apropiada.
Respuesta API	Una respuesta generada por el servidor API y devuelta al cliente.

Si deseas obtener más información sobre las API, accede al Portal para desarrolladores.