La API se utiliza para integrar las funciones de BotHelp en el proyecto personal del cliente. Está dirigida a desarrolladores y cuenta con documentación.
Para trabajar con estas configuraciones, es importante tener habilidades de desarrollo o contactar a un especialista experimentado.
Descripción
La API REST de BotHelp funciona mediante el protocolo HTTP y consiste en un conjunto de métodos que realizan solicitudes y devuelven respuestas para cada operación. Todas las respuestas se presentan en formato JSON.
El límite en la cantidad de solicitudes depende del método específico (consulte la documentación ).
No se permiten solicitudes entre dominios (por ejemplo, jQuery Ajax).
URL principal
Todas las referencias a solicitudes de API en esta documentación incluyen la URL base requerida:
https://api.bothelp.io
Autorización
El proceso de autorización es posible si existe una clave personal (token), que debe utilizarse para firmar cada solicitud a la API.
El código clave (token) se transmite en el encabezado de cualquier solicitud (en “headers”), excepto en los casos de recepción del propio token, cuando este código no es necesario.
Los parámetros necesarios para obtener la clave se encuentran en la configuración de la cuenta: ver la sección “Integraciones”.
Para obtener la clave, se envía una solicitud POST al enlace:
https://oauth.bothelp.io/oauth2/token
Para obtener un token de autorización, debe enviar datos a Form-data .
Parámetros de la solicitud:
grant_type debe ser igual a client_credentials
client_id su ID (API)
client_secret su secreto (API)
Ejemplo de respuesta:
{
"token_de_acceso": "tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc",
"token_type": "Portador",
"caduca en": 3600
}
Clave de ejemplo:
Autorización: Portador tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc
Nota: Tenga en cuenta que la clave recibida tiene una validez de una hora y no es necesario volver a solicitarla para cada operación. Cuando la clave caduque (una hora), deberá volver a solicitarla.
Posibilidades
Puede encontrar una lista de los métodos disponibles aquí .
Acciones con datos de suscriptores:
- descargar lista de suscriptores;
- cambiar los parámetros del suscriptor;
- establecer el valor de un parámetro personalizado;
- establecer/eliminar etiqueta;
- Obtén toda la información de tu suscriptor con un correo electrónico específico. Puedes hacerlo usando el filtro de correo electrónico.
- enviar un mensaje al suscriptor.
Acciones con el bot:
- agregar un suscriptor al bot en un paso determinado,
- Detener el bot para suscriptores.
Acciones con envío automático:
- añadir un suscriptor a la lista de correo automático,
- Eliminar suscriptor del envío automático de correos.
Restricciones
Para garantizar el funcionamiento estable de la plataforma, cada método API tiene un límite establecido en la cantidad de solicitudes por segundo.
| Límite | Se aplica a los puntos finales |
|---|---|
| 10 solicitudes/seg | - /v1/suscriptores/{id}/campospersonalizados- /v1/suscriptores/cuid/{cuid}/campospersonalizados- /v1/bots/{bot_referral}/pasos- /v1/embudos/- /v1/suscriptores/{id}/mensajes- /v1/bots/ |
| 25 solicitudes/seg | - /v1/suscriptores/cuid/{cuid}/mensajes- /v1/suscriptores/{id}/funnel- /v1/suscriptores/cuid/{cuid}/funnel- /v1/suscriptores/{id}/bot- /v1/suscriptores/cuid/{cuid}/bot |
Recomendación: utilice colas de solicitudes y pausas para evitar exceder los límites especificados.
Importante : en todas las tarifas de BotHelp, la funcionalidad de la solicitud externa y el webhook es la misma.
___________________________________________________________________
Si no has encontrado la respuesta a tu pregunta, pregúntanos en el chat dentro de tu cuenta o escríbenos a BotHelpSupportBot o a hello@bothelp.io
Obtenga 14 días de funcionalidad completa de la plataforma para crear mailings, autofunnels y chatbots BotHelp.