Esta sección describe los elementos comunes que deben utilizarse para consumir la API de Bily, incluyendo el esquema de autenticación, los encabezados requeridos y la estructura de las URLs de acceso.
Autenticación
La API de Bily utiliza autenticación mediante Bearer Token para identificar y autorizar a las aplicaciones que consumen los servicios.
Cada solicitud debe incluir un apikey(token de acceso) vigente en el encabezado Authorization.
Authorization: Bearer TU_API_KEYAdministra tus apikeys dentro de Bily desde de la opción Apikeys
Todas las solicitudes realizadas sin un token válido serán rechazadas con un error de autenticación.
ImportanteNo expongas tus apikeys con terceros que no sean de confianza, con ellas obtienes acceso a los recursos de la plataforma a través de tu cuenta.
Puedes revocar tus llaves en cualquier momento para invalidar su uso y el acceso a la plataforma.
Headers
Gran parte de los enpoints requieren identificar la empresa o sucursal sobra la cual se realizará la operación.
Para ello la API utiliza los siguientes encabezados personalizados.
| Header | Descripción |
|---|---|
X-Token-Emp | Identifica la empresa sobra la cual se llevará a cabo la operación |
X-Token-Suc | Identifica la sucursal propia de una empresa, sobra la cual se llevará a cabo la operación |
Base Url
Todas las solicitudes a la API deben realizarse sobre la siguiente URL base.
Sandbox
https://sandbox-api.bily.mx/Producción
https://api.bily.mx/El entorno Sandbox permite realizar pruebas de integración sin afectar la información de producción, en este entorno puedes validar tu integración antes de pasar al entorno productivo e inclusive utilzar datos reales para ello (recomendado).
Consulta nuestra guía Sandbox para conocer sus generalidades
Versionado
La API utiliza versionado en la URL para garantizar la estabilidad de las integraciones.
La versión a utilizar se especifica en el prefijo de la ruta como /api/v1/
Ejemplo de endpoint:
POST https://sandbox-api.bily.mx/api/v1/empresas
De esta manera cuando se publiquen nuevas versiones de la API, estas se expondrán mediante un nuevo prefijo de versión sin afectar las integraciones existentes.
Sincronización con tu cuenta de Bily
Para facilitar las pruebas y acelerar el proceso de integración, la documentación interactiva de Bily puede sincronizar automáticamente datos del entorno Sandbox tu cuenta.
Crea una cuenta en esta documentación utilizando el mismo correo electrónico que utilizaste durante la creación de tu cuenta de Bily, posteriormente inicia sesión, la plataforma podrá preconfigurar automáticamente ciertos valores utilizados en las solicitudes de ejemplo.
Entre los datos que pueden sincronizarse se incluyen:
- API Key del integrador
- Token de empresa (X-Token-Emp)
- Token de sucursal (X-Token-Suc)
Esto permite que al utilizar la opción Try It dentro de la documentación de cada endpoint, muchos de los campos requeridos ya se encuentren prellenados o sean sugeridos, facilitando así la ejecución de pruebas.
Si no inicias sesión en la documentación, aún podrás utilizar todos los ejemplos disponibles, pero deberás proporcionar manualmente los valores correspondientes para cada solicitud.
Prueba los endpoints desde la documentación
La documentación de Bily incluye herramientas interactivas que facilitan la exploración y prueba de la API, para cada endpoint encontrarás una descripción y ejemplos de solicitudes listos para ejecutar.
1.- Selecciona el lenguaje de integración de tu preferencia de una lista con más de 15 opciones.
2.- Selecciona un ejemplo de la lista de requests (en caso de aplicar)
3.- Haz clic en el botón Try it
4.- Consulta la respuesta del servicio
Puedes hacer clic en el código de respuesta correspondiente para desplegar un ejemplo ese tipo de respuesta.