🔑API Access

Descubre como autenticarte en el API de B2Chat

Para acceder al API de B2Chat primero debemos tener un token de acceso al API, para ello es importante conocer cómo puedes obtener el token de acceso.

Para obtener el token de acceso a todos los servicios del API debes tener acceso a tu cuenta de B2Chat como administrador, para poder acceder y obtener tu usuario y contraseña que te permitirán generar el token de acceso al API en el end-point de autenticación. Para esto debes realizar lo siguiente:

1. Iniciar sesión en tu cuenta de B2Chat.

2. Seleccionar la opción del menú llamada "Ajustes generales".

3. Seleccionar la opción del sub-menú llamada "Integraciones".

4. Seleccionar la opción "BotApi".

5. Tomar los datos de username (client_id) y password (client_secret)

Luego de obtener los datos anteriores, puedes enviar esa información al servicio de autenticación y el servicio te devolverá el token de acceso al API de B2Chat asociado a la suscripción de B2Chat del username y password ingresado.

El token generado para esa suscripción estará vigente por 24 horas, si en algún momento antes de su vencimiento se llama de nuevo el servicio de autenticación para la misma suscripción de B2Chat el API devuelve el mismo token vigente.

El endpoint de Autenticación es el siguiente:

https://api.b2chat.io/oauth/token

• Ejemplo de solicitud de autenticación:

curl --location --request POST 'https://api.b2chat.io/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--user 'username:password' \
--data-urlencode 'grant_type=client_credentials'

• Respuesta con éxito

#200
{
  "access_token":"4ba550ac-3259-4f27-93fd-78d2e853ab0f",
  "token_type":"bearer",
  "expires_in":86195,
  "scope":"all"
}

La respuesta proporciona un token del tipo "bearer", y el campo expire_in indica el tiempo restante en segundos hasta la expiración del token. Si al momento de solicitar el token no hay uno activo para la suscripción de B2Chat, se generará uno nuevo cuyo expire_in equivaldrá a 24 horas. Sin embargo, si al solicitar el token ya existe uno previamente creado y vigente para dicha suscripción, el servicio devolverá el mismo token, y en el campo expire_in se mostrará el tiempo restante, en segundos, hasta su vencimiento.

Buena Práctica: Implementa un mecanismo de recuperación de token en tu integración. Esto significa que si, al utilizar cualquier método del API, recibes un error 401 indicando "Token no autorizado", debes programar automáticamente la solicitud de un nuevo token. Con esta práctica, aseguras la continuidad y eficiencia de tu implementación sin interrupciones operativas.

Al tener los datos de username o password erroneos la respuesta del servicio será la siguiente:

#401
{
    "timestamp": 1706648268878,
    "status": 401,
    "error": "Unauthorized",
    "message": "Not found",
    "path": "/oauth/token"
}

---

Para verificar el estado de nuestra API puedes hacer un llamado:

curl --location --request GET 'https://api.b2chat.io/health' 

Al tener una respuesta exitosa del servicio se tendrá lo siguiente

#200
{
 "status": "UP" 
}