La API REST de Bily permite integrar y automatizar en tus sistemas todas las capacidades de la plataforma.

La API está diseñada para ser simple, consistente y completamente basada en JSON, permitiendo integraciones rápidas desde cualquier lenguaje o plataforma. Todos los endpoints siguen una estructura REST estándar y utilizan HTTPS para garantizar la seguridad de la comunicación.

Antes de comenzar

Antes de realizar tu primera llamada exitosa a la API necesitarás:

1.- Una cuenta activa en Bily

Crea tu cuenta sin costo para obtener acceso a la plataforma.

Consulta nuestra Guía de Inicio rápido para crear y configurar tu cuenta

2.- Una apikey de Sandbox para pruebas

Crea una apikey de pruebas desde tu Panel(Dashboard) para autenticarte en la API con tres sencillos pasos.

Inicia sesión en tu panel
Cambia al entorno Sandbox
Genera tu apikey de pruebas

Consulta nuestra Guía de Sandbox para ingresar al entorno y conocer sus alcances

Consulta el manual Integración - Apikeys para crear tu apikey

3.- Tokens de empresa y sucursal

La gran mayoría de las operaciones dentro de la API de Bily requieren de un identificador único (token) que representa la entidad (empresa o sucursal) bajo la cual Bily llevará a cabo la operación.

Al registrar una empresa en la plataforma se le asigna un identificador único (token de empresa) a su vez se crea una sucursal por defecto con su propio identificador único (token de sucursal).

📘
Puedes registrar empresas desde tu portal de administración o de forma automatizada desde la API
Nota: La creación de empresas desde la API sólo requiere de un apikey válido

Consulta de tokens desde el portal

Después de crear una empresa puedes consultar su token ingresando a Empresas

Consulta el token de la(s) sucursal(es) de una empresa ingresando a Sucursales

Consulta de tokens desde la API

Después de crear una empresa podrás encontrar sus identificadores únicos (tokens) bajo la siguiente estructura:

{
  "token": "emp_AEEQY5KJ3hN0iFdFSQBm4XuohG",
  ...
  "sucursales": [
    {
      "token": "suc_W39AfQbFRQRYpMkexl1C7Zy4PC",
	  ...
    }
  ]
}

También puedes consultar esta información durante la consulta o listado de empresas y sucursales.

Fundamentos

Consulta nuestra guía Fundamentos de la API para conocer sus generalidades como el método de autenticación, headers requeridos y el entorno Sandbox.