Открытое API
Ключи, webhook и примеры подключения.
Инструкции
- Создать ключ API: только чтение или чтение и запись
Как создать ключ API в КБП CRM: название, доступ «только чтение» или «чтение и запись». Ключ показывается один раз — храните его только на сервере.
- Отозвать ключ API
Как отозвать ключ API в КБП CRM: кнопка «Отозвать» — программы, которые им пользуются, перестанут работать с CRM.
- Webhook: CRM сама сообщает о событиях
Как добавить webhook в КБП CRM: адрес https, события, «Проверить», журнал доставки, выключить. CRM отправляет POST с данными сделки или клиента.
Обзоры
- Что можно сделать через API
Открытое API КБП CRM: доски, сделки, клиенты, комментарии и дела — получать, создавать и менять; webhook о событиях. Бесплатно.
- Журнал запросов ключа
Журнал запросов ключа API в КБП CRM: когда, какой запрос, ответ и IP — за 30 дней. Последний запрос и число запросов в списке ключей.
- Проверить подпись webhook (X-KBP-Signature)
Как проверить, что webhook пришёл из КБП CRM: заголовок X-KBP-Signature, HMAC-SHA256 от «время.тело» с секретом webhook, время не старше 5 минут.
- Пример: заявки с сайта через API
Когда передавать заявки с сайта в КБП CRM через API, а когда хватит формы заявок. Что передавать: клиент и сделка в первом этапе.
- Пример: связь с 1С
Как связать КБП CRM с 1С через API: что передавать из 1С в CRM и обратно, создание сделки из документа 1С.
- Пример: заказы Kaspi в CRM
Как получать заказы Kaspi.kz в КБП CRM: учётная программа или скрипт забирает заказы и создаёт сделки через API.
Вопросы и сообщения CRM
- Webhook выключился сам
Почему webhook КБП CRM выключился сам: 50 неудачных доставок подряд. Что проверить на сервере и как включить снова.
- «Слишком часто» и «Ключ API не действует»
Ошибки API КБП CRM: 429 — больше 300 запросов в минуту, 401 — ключ отозван или недействителен, 403 — нет права или ключ «только чтение».