El diccionario de suscripciones

Application Programming Interface

¿Qué es una API?

Una API es una interfaz acordada que el software utiliza para intercambiar datos o pedir a otro programa que realice una acción. API significa Application Programming Interface. Describe lo que ofrece un sistema y cómo puede utilizarlo otro.

Elaborado con IAContenido actualizado

Una solicitud tiene una dirección y un propósito

Con una API HTTP, tu código envía una solicitud a una dirección concreta, llamada endpoint. El método indica el tipo de acción. GET recupera información. POST suele crear algo o iniciar una operación. La documentación de cada endpoint determina su comportamiento exacto.

La respuesta incluye un código de estado y puede contener datos estructurados, como JSON. Tu código utiliza esa respuesta para continuar. Una buena integración también prevé qué hacer si hay que repetir una solicitud o revisar algún problema.

Un ejemplo concreto

Solicitar los clientes de Alunta

Una solicitud de lectura documentada, mostrada sin token de acceso a modo de ejemplo.

GET https://app.alunta.com/api/v1/customers

Método
GET, recuperar información
Recurso
/customers, clientes
Autenticación
Token bearer
Si la solicitud tiene éxito
Datos de clientes en JSON

Esta solicitud no modifica datos. Consulta la referencia sobre la estructura de respuestas, la paginación y los requisitos de acceso antes de implementarla.

La documentación y el acceso van de la mano

La referencia de la API de Alunta describe recursos como clientes, suscripciones y facturas. El archivo OpenAPI describe la interfaz en un formato que también pueden leer las herramientas de desarrollo: direcciones, campos, respuestas y requisitos de autenticación.

El ejemplo requiere un token bearer válido con acceso suficiente a tu cuenta de Alunta. Guárdalo de forma segura en tu servidor, fuera del código del navegador accesible públicamente. La documentación y los permisos del token determinan la información y las acciones a las que puede acceder una integración. Empieza con una solicitud de lectura para entender la respuesta antes de añadir cambios al flujo.

Las API, los webhooks y MCP tienen funciones distintas

Con una API, tu código inicia la solicitud: «Obtén mis clientes». Con un webhook, el sistema envía un mensaje a tu integración cuando ocurre un evento, como un pago. Así puedes evitar las solicitudes repetidas que solo sirven para buscar cambios.

MCP es un estándar que conecta aplicaciones de IA con datos y herramientas externas. Ofrece una forma diferente de presentar capacidades seleccionadas a un asistente. No expone automáticamente todas las funciones de una API. Consulta las páginas de API y acceso a IA de Alunta y elige la conexión adecuada para la tarea de tu flujo de trabajo.

Preguntas y respuestas

¿Una API es lo mismo que una integración lista para usar?

No. Una API es una interfaz con la que puedes crear una integración. Una integración lista para usar conecta sistemas y ya resuelve decisiones sobre los datos, la sincronización y los errores.

¿Necesito ser desarrollador para usar Alunta?

No. Puedes usar la interfaz de Alunta y las integraciones listas para usar. La API sirve para flujos en los que tu propio código debe conectar Alunta con otro producto o proceso.

Fuentes y documentación