{"id":397,"date":"2024-09-21T17:58:23","date_gmt":"2024-09-21T14:58:23","guid":{"rendered":"https:\/\/help.testbh.ru\/?p=397"},"modified":"2025-11-05T13:18:35","modified_gmt":"2025-11-05T10:18:35","slug":"api-bothelp","status":"publish","type":"post","link":"https:\/\/help.bothelp.io\/en\/api-bothelp\/","title":{"rendered":"API BotHelp"},"content":{"rendered":"

The API is used to integrate the BotHelp capabilities into the client’s personal project. The API is intended for developers and is accompanied by documentation.<\/p>\n

Description<\/h4>\n

The BotHelp REST API operates with the HTTP protocol and is a set of methods used to make queries and return responses for each operation. All responses come in the form of JSON structures.<\/p>\n

The limit on the number of queries depends on the specific method (see the documentation<\/a>).<\/p>\n

Cross-domain queries (e.g., jQuery Ajax) are prohibited.<\/strong><\/p>\n

Main URL<\/h4>\n

All API query links in this documentation include the required main URL:https:\/\/api.bothelp.io<\/code><\/p>\n

Authorization<\/h4>\n

The authorization process is possible if you have a personal key (token) that you have to sign each API query with.<\/p>\n

The key code (token) is passed in the header of every query (in “headers”), except when the token itself is received, when this code is not required.<\/p>\n

The necessary parameters for obtaining the key can be found in the profile settings: see the “Integrations” section.<\/p>\n

To receive the key, a “POST” query is sent via the link:https:\/\/oauth.bothelp.io\/oauth2\/token<\/code><\/p>\n

To get an authorization token, you have to send data to Form-data<\/strong>.<\/p>\n

Query Parameters:<\/strong><\/p>\n


\ngrant_type must be equal to client_credentials<\/code><\/p>\n

client_id your ID (API) <\/code><\/p>\n

client_secret your secret (API)<\/code><\/p>\n

Example of a response: <\/strong>{<\/code><\/p>\n

\"access_token\": \"tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc\", <\/code><\/p>\n

 \"token_type\": \"Bearer\",<\/code><\/p>\n

\"expires_in\": 3600<\/code><\/p>\n

}<\/code><\/p>\n

Example of a key:<\/strong><\/strong>Authorization: Bearer tf4Si1LydYpTAPyHXUgjig72jlrd5HpIJL5oigmc<\/code><\/p>\n

 <\/p>\n

Note<\/strong>. Please note that the received key is valid for 1 hour and does not require a repeat query for each operation. When the key expires (1 hour), you have to send a repeat query to receive it.<\/p>\n

Opportunities<\/h4>\n

You can find the list of available methods here<\/a>.<\/strong><\/p>\n

Actions with person data:<\/p>\n