APIs
Application Programming Interface
1
¿Qué es un API?
Application Programming Interface
Application Programming Interface
Capaz de transformar las señales generadas por un sistema en señales comprensibles por otro
API
Una interfaz para que apps programadas puedan comunicarse sin tener que entenderse por completo
2
Ejemplos de uso de APIs
1. App tipo Uber
Sus features principales giran en torno a trabajar con mapas
Se estima que hay unos 32 millones de kilómetros de carreteras o caminos transitables en todo el planeta
Ejemplo de API: App tipo Uber
App de mapas
App de mapas con Google Maps
Ejemplo de API: App tipo Uber
2. HubSpot con Gmail
HubSpot permite enviar emails desde la vista de registro de contacto y empresa
Ejemplo de API: HubSpot con Gmail
Gmail tiene un API para que otras apps puedan enviar emails desde su interfaz
HubSpot con capacidad de envío de emails
Ejemplo de API: HubSpot con Gmail
3
¿Cómo funcionan las APIs?
Depende de cómo esté construida
Lo más común que vamos a encontrar son APIs REST 🤲🏽🙏🏽
Conceptos comunes
Es un estilo de arquitectura para crear APIs. Es el que usa HubSpot y en el que vamos a enfocarnos.
1
REST
Es un protocolo de intercambio de mensajes en formato XML.
2
SOAP
API
API
Documentación
Conceptos comunes
2
Privadas
Requiere una autenticación.
Se una un token (es un objeto con todos los datos de la autenticación)
Los tokens tienen vigencia configurable.
1
Públicas
Cualquier persona puede acceder.
4
¿Cómo funcionan las APIs REST?
Conceptos de API REST
Formatos de respuesta
Cómo la API responde información a quien se la pide.
Métodos HTTP
Nos ayudan a interactuar con la API.
Consulta de recursos
Cada sección de la URI nos permite consultar un recurso (objeto del software).
Códigos de respuesta
Cada consulta al server me devuelve un código, cada código significa algo.
1. Métodos HTTP
Cliente
GET
POST
PUT
DELETE
JSON
Server
HTTP REQUEST
HTTP RESPONSE
API
https://www.dinterweb.com
1. Métodos HTTP
Cliente
GET
POST
PUT
DELETE
Server
API
Cada objeto que el API permite interactuar tiene un URI.
A toda la URL completa se le conoce como endpoint.
2. Consulta de recursos
2. Consulta de recursos
Cliente
Server
API
GET
POST
PUT
DELETE
2. Consulta de recursos
Cliente
Server
API
api.hubspot.com/contacts
api.hubspot.com/companies
api.hubspot.com/deals
api.hubspot.com/tickets
api.hubspot.com/chatflows
GET
POST
PUT
DELETE
2. Consulta de recursos
Las APIs REST pueden devolver la información en distintos formatos.
- JSON: Es el estándar y el más sencillo
- XML: Poco usado y más complejo
- Texto plano: Algunos sistemas requieren que se utilice
3. Formatos de respuesta
3. Formatos de respuesta
Cliente
JSON
Server
API
GET
POST
PUT
DELETE
Cuando se solicita una información el servicio contesta con distintos códigos
- 2XX: Todo fue exitoso
- 3XX: Redirecciones
- 4XX: Solicitud inválida (404 a recurso que no existe)
- 5XX: Error en el servidor
4. Códigos de estado
Cliente
JSON
Server
HTTP REQUEST
HTTP RESPONSE
API
GET
POST
PUT
DELETE
Dominio
URI
Endpoint o URL