Las APIS son un conjunto de protocolos que establecen las reglas de comunicación entre dos sistemas de software. En otras palabras, es un contrato que define cómo dos aplicaciones pueden interactuar entre sí.
Las APIS de BYMA te permitirán acceder a información en tiempo real, obtener conocimiento de mercado y optimizar tus estrategias de inversión para alcanzar tus objetivos financieros.
REQUISITOS PARA EL USO DE APIs
Según el tipo de API que deseemos implementar, será diferente el estándar de requisitos para su aprobación y posterior uso.
En las APIs detalladas en esta página podrás encontrar el correo electrónico de contacto para solicitar la información específica de cada uno de los requisitos y su documentación.
Es importante tener en cuenta que la implementación de APIs solo se encuentra disponible para agentes Miembros BYMA, a excepción de las APIs de Market Data.
Las API son herramientas que permiten la integración y la interoperabilidad entre sistemas diferentes, lo que impulsa la creación de aplicaciones más complejas y robustas.
En otras palabras, es un contrato que define cómo dos aplicaciones pueden interactuar entre sí, especificando cuestiones tales como los puntos de acceso que utilizarán para comunicarse entre sí, las acciones que se realizarán, y el formato que tendrán los datos en estas aplicaciones.
Un método o “endpoint” es una acción que podés realizar con la API, permitiéndote acceder a las diferentes funcionalidades de la misma.
A través de estas órdenes que se realizan a las APIS, se obtiene información, o bien es posible realizar determinadas acciones.
El método en una API determina el tipo de solicitud que estás enviando al servidor para interactuar con los recursos que proporciona la API.
Los métodos más comunes que se utilizan en las API web están definidos por el protocolo HTTP y son los siguientes:
● GET
● POST
● PUT
● DELETE
● PATCH
De todas formas, es importante consultar la documentación disponible para cada API, a fin de conocer qué tipo de solicitudes se encuentran disponibles para cada una de ellas. (Si bien la mayoría de las APIs sigue los estándares HTTP para los tipos de solicitud, cada una tiene sus propios requisitos).
Las APIs pueden manejar una variedad de formatos de respuesta para devolver datos al cliente. Algunos de los formatos de respuesta más comunes incluyen:
● JSON (JavaScript Object Notation)
● XML (eXtensible Markup Language)
● HTML (Hypertext Markup Language)
● Texto sin formato
● Imágenes y archivos binarios
● Otros formatos específicos
Si bien existen varias formas de conocer la respuesta que entregará un método, la mejor fuente de información sobre la respuesta de un método es la documentación de la API. Es posible utilizar herramientas tales como Postman para probar el método y ver la respuesta que se genera.
A través de la autenticación es posible verificar la identidad del usuario o aplicación que intenta acceder a una API. Es importante para proteger los datos y funcionalidades de la misma.
Nos permitirá acceder a las APIs solo si somos usuarios autorizados, existiendo varios métodos para lograr esa autenticación.
Proceso de autenticación:
El usuario o aplicación envía una solicitud a la API.
La solicitud incluye las credenciales de autenticación, como un nombre de usuario y contraseña, una API key o un token de acceso.
La API verifica las credenciales.
Si las credenciales son válidas, la API concede acceso al usuario o aplicación.
Si las credenciales no son válidas, la API deniega el acceso.
Métodos de autenticación:
OAuth: Es un método popular que permite a los usuarios autenticarse a través de un proveedor de identidad como Google, Facebook o Twitter.
API keys: Son claves únicas que se asignan a cada usuario o aplicación.
Tokens de acceso: Son claves temporales que se generan para una sesión específica.
El proceso de obtención de credenciales para la consulta varía según la API.
1. Registro: Algunas APIs requieren que te registres para obtener una cuenta. Durante el registro, se te pedirá que proporciones información como tu nombre, correo electrónico y contraseña. Una vez que te hayas registrado, recibirás tus credenciales por correo electrónico o en el
panel de control de la API.
2. API Key: Algunas APIs te dan una API key que puedes usar para autenticarte. Puedes encontrar tu API key en la documentación de la API o en el panel de control de la API.
3. Token de acceso: Algunas APIs te dan un token de acceso que debes usar para autenticarte. Puedes obtener un token de acceso mediante una solicitud a la API.
La documentación de la API te indicará cómo obtener un token de acceso.
El proceso para conocer tu consumo de las APIs varía según la API:
1. Panel de control de la API: Algunas tienen un panel de control donde podés visualizar tu consumo de la misma. El panel de control te mostrará
información como la cantidad de solicitudes que realizaste, el volumen de
datos que transferiste y el tiempo que pasaste usándola.
2. Facturación: Si estás pagando por una API, tu factura te mostrará tu consumo de la misma. La factura te mostrará información como la cantidad de solicitudes que has realizado, el volumen de datos que has transferido y el costo de tu consumo.
3. API Key: Algunas APIs te permiten rastrear tu consumo usando una API key. Podés usar una herramienta como Postman para rastrear tu consumo la
API key indicada.
Los códigos de éxito y de error en una API te ayudan a entender el resultado de una solicitud. Cada método de API produce una respuesta que indica si la acción fue exitosa o si ocurrió algún error.
Algunos ejemplos de estados de respuesta estándar son:
● 200 OK,para indicar éxito.
● 400 Bad Request, para errores de cliente.
● 500 Internal Server Error, para errores del servidor.
Algunas recomendaciones que te permitirán conocer dichos códigos:
1. Documentación de la API: La mejor fuente de información sobre los códigos de éxito y de error es la documentación.
2. Probar la API: Podés usar una herramienta como Postman para probar la API y ver los códigos de éxito y de error que se generan.
Consultar un método desde Postman implica enviar una solicitud HTTP al servidor que aloja la API y luego analizar la respuesta. Se detallan a continuación los pasos básicos para consultar un método utilizando Postman:
● Abrir Postman: Inicia la aplicación Postman en tu dispositivo.
● Crear una nueva solicitud: En la barra lateral izquierda de Postman, hacé clic en el botón “New” para crear una nueva solicitud. Seleccioná el método HTTP que deseas utilizar (GET, POST, PUT, DELETE, etc.).
● Configurar la solicitud: Completá los campos necesarios para tu solicitud, como la URL del endpoint, los parámetros de consulta, los encabezados y el cuerpo de la solicitud (si corresponde). Podés configurar estas opciones en las pestañas correspondientes en la parte inferior de la ventana de Postman.
● Enviar la solicitud: Una vez que hayas configurado tu solicitud, hacé clic en el botón “Send” para enviarla al servidor. Postman enviará la solicitud al servidor y mostrará la respuesta en la ventana principal.
● Analizar la respuesta: Postman mostrará la respuesta del servidor, que incluye el código de estado HTTP, los encabezados de respuesta y el cuerpo de la respuesta (si corresponde). Podés analizar esta información para verificar si la solicitud se procesó correctamente y para ver los datos devueltos por el servidor.
Recordá que es importante verificar que la solicitud se haya procesado correctamente y que la respuesta del servidor sea la esperada. Si encontrás algún problema, podés ajustar la configuración de la solicitud en Postman y volver a enviarla para probar nuevamente.
