Glosario
En este glosario, encontrarás definiciones y explicaciones claves para comprender mejor el mundo de las interfaces de programación de aplicaciones (APIs). Desde conceptos básicos hasta detalles avanzados, este glosario te ayudará a navegar por el fascinante universo de las APIs.
- Portal del Desarrollador: El portal del desarrollador es una interfaz web donde los desarrolladores pueden descubrir, explorar y aprender sobre las API disponibles. Proporciona documentación, ejemplos, pruebas y acceso a claves de API.
- Catálogo: Un destino de preparación (staging) que se comporta como una partición lógica de la puerta de enlace y el Portal del Desarrollador. Las URL para llamadas de API y para el Portal del Desarrollador son específicas de un catálogo particular.
- Catálogo de API: Un catálogo es un destino de preparación (staging) que se comporta como una partición lógica de la puerta de enlace y el Portal del Desarrollador.
- ID de cliente: Información que identifica una aplicación individual. Una aplicación puede invocar una API solo si pasa una clave de aplicación reconocida por el sistema y se le otorga acceso a la API.
- Secreto de cliente: Información utilizada junto con la clave de aplicación para verificar la identidad de una aplicación. Una API puede configurarse para requerir que las aplicaciones cliente suministren su secreto de cliente junto con su ID de cliente.
- Operación de API: Llamada de API REST que consta de un verbo HTTP y una ruta de URL (punto final). Por ejemplo, GET /api/usuarios devuelve una lista de usuarios.
- Documentación de API: La documentación de API proporciona detalles sobre cómo usar una API, incluidos ejemplos de solicitud y respuesta, parámetros, autenticación y más. Es esencial para que los desarrolladores comprendan y utilicen correctamente las API.
- Autenticación de API: Los métodos de autenticación, como tokens de acceso, claves de API o certificados, garantizan que solo las aplicaciones autorizadas puedan acceder a una API.
- Límite de tasa (Rate Limiting): Establece cuántas solicitudes de API un cliente puede realizar en un período de tiempo específico.
- Producto de API: se refiere a un conjunto de APIs que ofrecen capacidades dentro de un mismo contexto funcional o una misma línea de negocio. Es la unidad mínima por la cual se puede consumir un API.
- Endpoint: Es una ubicación digital donde una API recibe solicitudes relacionadas con un recurso específico en su servidor. En términos más sencillos, un endpoint permite especificar la “ubicación” de un recurso dentro de una API. Por lo general, se representa como una URL (Uniform Resource Locator) que indica dónde se encuentra ese recurso en el servidor. Cuando los clientes interactúan con una API, especifican un endpoint en sus solicitudes para acceder a los recursos deseados.
- Rutas: Son fundamentales para dirigir las solicitudes entrantes a los recursos adecuados en el servidor. Son combinaciones de un método HTTP y una ruta de recurso. Las rutas son como señales de tráfico que guían las solicitudes hacia los recursos correctos dentro de tu API.
- Códigos de estado de respuesta HTTP: indican si se ha completado satisfactoriamente una solicitud HTTP específica. Estas respuestas se agrupan en cinco clases: Respuestas Informativas (100–199), Respuestas Satisfactorias (200–299), Respuestas de Redirección (300–399), Respuestas de Error del Cliente (400–499), Respuestas de Error del Servidor (500–599).
¿Por qué veo una página de acceso denegado?
Cuando ves una página con el mensaje "Acceso denegado", significa que no tienes permiso para acceder a ese recurso.
Esto puede deberse a varias razones:
- Permisos insuficientes: No tienes los permisos necesarios para ver la página o el archivo en cuestión.
- Restricciones de IP: La dirección IP desde la que estás accediendo está bloqueada o restringida.
- Autenticación requerida: La página requiere que inicies sesión o te autentiques antes de acceder.
¿Qué debo hacer si mi clave de API ha sido comprometida?
Si crees que tu clave de API ha sido comprometida, desactívala inmediatamente desde la sección "Mis Aplicaciones" y genera una nueva clave. También, contacta a nuestro equipo de soporte para informar sobre el incidente.
¿Cómo puedo reportar un problema o solicitar soporte?
Si encuentras algún problema o necesitas asistencia, puedes contactar a nuestro equipo de soporte a través del formulario de contacto en el portal de desarrolladores.
¿Qué políticas de seguridad siguen las API?
Nuestras API siguen las mejores prácticas de seguridad, incluyendo el uso de HTTPS para todas las comunicaciones, autenticación robusta y limitación de tasas de solicitud para prevenir abusos.