Glosario - Centro de Ayuda
Glosario
Domina sin problemas las diferentes terminologías de nuestro API Market Transbank. Es por esto, que dejamos la definición de cada concepto aquí:
API
Una API (Interfaz de Programación de Aplicaciones) es una herramienta que permite que dos aplicaciones o sistemas se conecten e intercambien información. Es la base para integrar servicios o automatizar procesos.
API Key
Una API Key es como una contraseña única que identifica y autentica una aplicación cuando se conecta a una API. Es esencial para garantizar un uso seguro y controlado.
API Marketplace
Un API Marketplace es una plataforma que organiza y centraliza múltiples APIs. Te permite descubrir, evaluar y contratar APIs fácilmente en un solo lugar, como si fuera una tienda para desarrolladores.
API REST
API REST (Representational State Transfer) es un tipo de API que utiliza métodos estándar de HTTP, como GET y POST, para transferir datos. Es una forma sencilla y eficiente de conectar aplicaciones y sistemas.
Aplicación
Una aplicación es un registro dentro del Marketplace que representa un proyecto, sistema o solución que necesita interactuar con las APIs. Cada aplicación actúa como un identificador único para gestionar el acceso, las claves de autenticación y los permisos necesarios para conectar de manera segura tu proyecto con nuestras herramientas.
Autenticación
La autenticación es el proceso de verificar quién eres, como cuando inicias sesión con un usuario y contraseña. En el caso de las APIs, se hace para confirmar que la aplicación o usuario tiene permiso para acceder.
Autorización
Después de autenticarte, la autorización define lo que puedes hacer. Por ejemplo, una API puede permitirte leer datos, pero no modificarlos, según los permisos asignados.
Burst Limit
El burst limit te permite manejar picos de tráfico enviando un número mayor de solicitudes en un corto período, siempre respetando los límites generales de la API.
Credenciales
Son los datos necesarios para autenticarte y acceder a una API, como una clave o token. Garantizan que solo usuarios autorizados puedan usar el servicio.
Dashboard
Un dashboard es un panel visual donde puedes monitorear métricas importantes sobre el uso de tus APIs y aplicaciones, como solicitudes exitosas, errores y consumo.
Endpoint
Un endpoint es una URL específica dentro de una API que te permite acceder a una función o servicio, como consultar usuarios, procesar pagos o verificar transacciones.
HTTP Status
El HTTP Status es un código que indica el resultado de una solicitud a una API. Por ejemplo, 200 significa éxito, 404que no se encontró el recurso, y 500 que hubo un error en el servidor.
JSON
JSON (JavaScript Object Notation) es un formato de datos ligero que se usa para intercambiar información entre aplicaciones. Es fácil de leer tanto para humanos como para computadoras.
Límite de concurrencia
El límite de concurrencia define cuántas solicitudes simultáneas puede manejar una API por usuario o aplicación. Ayuda a mantener la estabilidad del servicio, incluso con alta demanda.
Mock API
Una Mock API es una simulación de una API real. Sirve para probar integraciones y validar cómo funcionará tu aplicación antes de implementar la API definitiva.
Plan
Un plan define el nivel de servicio de un producto API. Determina aspectos como la cantidad de solicitudes permitidas, las funcionalidades disponibles y el modelo de cobro.
Plugin
Un plugin es un componente adicional que se integra en una aplicación o sistema para ampliar su funcionalidad. Por ejemplo, puede añadir herramientas de análisis o mejorar la seguridad.
Producto API
Un producto API es un conjunto organizado de una o más APIs diseñadas para resolver necesidades específicas de negocio. Incluye planes que ajustan el uso según tus requerimientos.
Query Parameters
Son datos adicionales que se envían en la URL para modificar o filtrar las respuestas de una API. Por ejemplo, en https://api.ejemplo.com/usuarios?id=123, el parámetro de consulta es id=123.
Rate Limit
El rate limit establece la cantidad máxima de solicitudes que puedes hacer a una API en un tiempo definido, como 1.000 por minuto. Protege la API de sobrecarga y asegura un servicio estable.
Request
Una request (solicitud) es una petición enviada a una API para obtener información o realizar una acción. Incluye datos como la URL del endpoint y parámetros.
Response
Una response (respuesta) es lo que la API devuelve después de procesar una solicitud. Puede incluir los datos solicitados, un mensaje de error o una confirmación.
Sandbox
Una sandbox es un entorno seguro para probar APIs sin afectar sistemas reales. Es ideal para aprender y validar integraciones antes de usarlas en producción.
SDK
Un SDK (Kit de Desarrollo de Software) es un conjunto de herramientas y bibliotecas que ayuda a los desarrolladores a integrar una API de forma rápida y eficiente.
Es una clave privada compartida entre el cliente y la API para firmar y validar solicitudes. Se usa para garantizar la seguridad y prevenir accesos no autorizados.
Token
Un token es una clave única que autoriza el acceso a una API. Es como una contraseña, pero más segura, y puede tener permisos y tiempos de validez específicos.
Web service
Un web service es un sistema que permite que dos aplicaciones intercambien datos a través de internet. Puede usar estándares como SOAP o REST.