API: ключи доступа

Через API Докифай подключают к своим системам: CRM, внутренним сервисам, сценариям автоматизации. API работает с данными рабочей области — контактами, ссылками, дата-румами, файлами и визитами.

API доступен на тарифах «Команда» и «Бизнес». Ключами управляют владелец и администраторы.

Как создать ключ

1. «Настройки» → «API».
2. Нажмите «Создать ключ» и дайте ему понятное название, например «Интеграция с CRM».
3. Скопируйте ключ из окна «Скопируйте API-ключ».

Полный ключ показывается только один раз. Сохраните его в надёжном месте — в менеджере паролей или хранилище секретов вашей системы. Если ключ потерян, создайте новый, а старый отзовите.

Как пользоваться

Передавайте ключ в каждом запросе в заголовке:

Authorization: Bearer dfy_…

Проверить ключ можно запросом GET https://api.docify.ru/api/v1/me — в ответе будет рабочая область, к которой он привязан. Полная документация — по ссылке «Документация API» на странице «API».

Что умеет API

• Контакты — получить, создать, изменить, удалить.
• Ссылки — получить, создать, изменить, удалить.
• Дата-румы — получить, создать, изменить, удалить.
• Файлы — получить список и файл, удалить. Загрузки файлов через API пока нет.
• Визиты — получить список визитов области.

Ключ привязан к одной рабочей области и работает с её данными. Действия через API попадают в журнал действий с названием ключа.

Ограничения

• Не больше 120 запросов в минуту на один ключ.
• Лимиты тарифа действуют и для API: например, дата-румов не создать больше, чем разрешено.

Отзыв ключа

В таблице ключей — «Отозвать». Приложения с этим ключом сразу потеряют доступ. В колонке «Использован» видно, когда ключ последний раз обращался к API, — неиспользуемые ключи лучше отзывать.

Что дальше

• Вебхуки: события в вашу систему — получать события без опроса API.
• Журнал действий: кто что менял — где видны действия через API.