Glosario de API
Terminología esencial de API que todo desarrollador debe conocer
API (Interfaz de programación de aplicaciones)
Un conjunto de definiciones y protocolos que permite que diferentes aplicaciones de software se comuniquen entre sí. Las APIs definen los métodos y formatos de datos que las aplicaciones pueden usar para solicitar e intercambiar información.
Ejemplo: Requiems API proporciona una API REST para validar direcciones de correo electrónico programáticamente.
Endpoint
Una URL específica donde una API puede acceder a los recursos que necesita. Cada endpoint corresponde a una función o recurso específico en la API.
Ejemplo: POST /v1/email/disposable/check
Autenticación
El proceso de verificar la identidad de un usuario o aplicación. Las APIs generalmente requieren autenticación para garantizar que solo los usuarios autorizados puedan acceder al servicio.
Ejemplo: Incluir tu clave API en el encabezado Authorization: Authorization: Bearer TU_CLAVE_API
Clave API
Un identificador único utilizado para autenticar solicitudes a una API. Las claves API actúan como identificador y token secreto para la autenticación.
Ejemplo: req_live_1234567890abcdef
Limitación de tasa
Una técnica para controlar el número de solicitudes que un usuario puede hacer a una API dentro de un período de tiempo dado. Esto ayuda a prevenir abusos y garantiza un uso justo.
Ejemplo: El plan gratuito permite 100 solicitudes por minuto
Solicitudes
La unidad de uso de la API. Cada llamada a la API cuenta como 1 solicitud contra tu cuota mensual del plan. Algunos endpoints pueden contar como más de 1 solicitud, lo cual siempre se indica explícitamente en la documentación de ese endpoint.
Ejemplo: Llamar al endpoint de validación de correo una vez usa 1 solicitud de tu cuota mensual.
REST (Transferencia de estado representacional)
Un estilo arquitectónico para diseñar aplicaciones en red. Las APIs REST usan solicitudes HTTP para realizar operaciones CRUD (Crear, Leer, Actualizar, Eliminar) sobre recursos.
Ejemplo: Usar GET para recuperar datos, POST para crear, PUT para actualizar, DELETE para eliminar
JSON (Notación de objetos de JavaScript)
Un formato de intercambio de datos ligero que es fácil de leer y escribir para humanos, y fácil de analizar y generar para máquinas. La mayoría de las APIs modernas usan JSON para los cuerpos de solicitud y respuesta.
Ejemplo: {"email": "[email protected]", "is_disposable": false}
Códigos de estado HTTP
Códigos de tres dígitos devueltos por los servidores web para indicar el resultado de una solicitud HTTP. Los códigos comunes incluyen 200 (éxito), 404 (no encontrado) y 500 (error del servidor).
Más información: Referencia de códigos de error
Webhook
Un método para que una aplicación proporcione información en tiempo real a otras aplicaciones. En lugar de que hagas solicitudes repetidas a la API, el servidor envía datos a tu URL especificada cuando ocurre un evento.
Ejemplo: Recibir una notificación cuando tu saldo de solicitudes caiga por debajo de un umbral
Parámetros de consulta
Pares clave-valor añadidos a una URL para filtrar, ordenar o modificar la respuesta de la API. Aparecen después de un signo de interrogación (?) en la URL.
Ejemplo: /v1/words?limit=10&min_length=5
Encabezados
Información adicional enviada con las solicitudes y respuestas HTTP. Los encabezados pueden contener tokens de autenticación, tipos de contenido, metadatos personalizados y más.
Ejemplo: Content-Type: application/json
¿Necesitas más ayuda?
Consulta nuestra documentación completa o contacta a nuestro equipo de soporte