Esta infografía reúne el vocabulario de las integraciones con APIs HTTP: peticiones, endpoints, respuestas y controles de acceso. Sirve como referencia visual para seguir una conversación o repasar un término. La guía práctica de APIs desarrolla estos conceptos mediante un historial de pedidos y las preguntas necesarias para evaluar su integración.
Leer el intercambio desde la aplicación que pregunta
Una aplicación envía una petición a un endpoint, con el método HTTP y la información necesaria para la operación. El servicio receptor aplica sus reglas y devuelve una respuesta. El código de estado describe el resultado HTTP, mientras que el cuerpo puede contener registros, el estado de una operación o detalles de un error. En un pago, una petición correcta puede dejar pendiente un procesamiento de negocio posterior.
El método orienta sobre la operación. GET recupera una representación, POST envía datos para procesarlos, PUT crea o sustituye el estado de un recurso, PATCH aplica una modificación parcial y DELETE solicita la eliminación de un recurso. La conservación de datos y el borrado definitivo dependen del contrato. JSON es un formato habitual para los campos y valores intercambiados, no un requisito de todas las APIs.
Utilizar el dibujo para situar la siguiente pregunta
- Para identidad, permisos y desconexión, puede consultarse claves de API frente a OAuth. OAuth es un marco de autorización, no otro nombre para iniciar sesión.
- Para el volumen de llamadas permitido, la referencia es límites de peticiones de API. La paginación puede exigir varias llamadas para recuperar todos los resultados.
- Para cambios de estado posteriores, puede compararse webhooks y polling. Las notificaciones y las consultas a la API pueden trabajar juntas.
- Para las decisiones de adopción e inversión cuando la propia API es la oferta, el siguiente paso es gestión de APIs como producto.
El libro APIs para Product Managers desarrolla los conceptos de la infografía. Para una primera revisión de integración, la definición de integración de la guía los relaciona con requisitos concretos.
