Introducción a la API

Consideraciones iniciales

El uso de esta API está restringido a equipos de desarrollo. Se requiere conocimientos técnicos avanzados para comprender muchos de los conceptos expuestos en esta guía. Si tienes alguna duda, ponte en contacto con nuestro departamento de soporte a través del email soporte@yamp.ink

Autenticación

Para comunicarte con nuestra API debes utilizar las credenciales correspondientes al tipo de operación e incluirlas en las cabeceras de tus peticiones. Existen dos tipos:

• Gestión de Agencias
• Producto

Credenciales para la Gestión de Agencias

Si la integración que llevas a cabo require de la gestión de múltiples agencias necesitarás una API_KEY. Esta llave de acceso será proporcionada por nuestro equipo mediante solicitud. Una vez la tengas, incluye la cabecera Yamp-Api-Key en tus peticiones. Ten en cuenta que tu API_KEY te identificará y dará acceso a todas las operaciones para la gestión de agencias en Yamp. Por seguridad, no compartas tu API_KEY con nadie ajeno a tu empresa.

Credenciales de Producto

Las operaciones con la API de Producto requiren del uso de un token tipo Bearer. Por tanto, deberás realizar un login de usuario para obtener el token e incluirlo en la cabecera Authorization de todas tus peticiones.

Uso de la API

Nuestra API es RESTful por lo que podrás comunicarte mediante el protocolo HTTP a los endpoints utilizando los métodos GET, POST, PUT, DELETE según se indique. La respuesta se entregrará en formato JSON. Puedes consultar el listado de endpoints en nuestro Swagger

URL Base

Entorno de Pruebas

Las peticiones se realizarán a la URL:

https://api-dev.yamp.app/

Entorno de Producción

Las peticiones se realizarán a la URL:

https://api.yamp.app/