Докифай
Чем можем помочь?

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

4 мин чтения · обновлено 15.10.2026

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

Видеоурок: Как подключить API и вебхуки.

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

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

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

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

«API-ключи» со списком ключей

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

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

Authorization: Bearer dfy_…

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

Что умеет API

  • Контакты — получить, создать, изменить, удалить; найти по почте; завести или обновить по почте — без дублей.
  • Группы получателей — получить, создать, изменить, удалить; добавить и убрать людей и компании.
  • Ссылки — получить, создать, изменить, удалить, в том числе ссылку для группы. В ответе — полный адрес ссылки, его можно сразу отправить клиенту.
  • Дата-румы — получить, создать, изменить, удалить; добавить документы и папки, получить состав по порядку и с номерами; задать, что видит в дата-руме каждая группа.
  • Файлы — загрузить, получить список и файл, удалить. Загрузить можно файлом, по ссылке — например, вложение из CRM — или в два шага, если файл больше 100 МБ.
  • Визиты — получить визиты области: по ссылке, человеку, документу или дата-руму.
  • Соглашения перед просмотром — получить соглашения, журнал принятий и PDF-сертификат принятия. Ставить соглашение на ссылку — полем ссылки.
  • Вопросы получателей — получить вопросы, которые получатели задали вам, и ответы на них. Отвечают в кабинете: ответ уходит получателю письмом.
  • Вебхуки — подписаться на события и отписаться. Так сервисы автоматизации подключаются сами, когда вы включаете сценарий.

Контакты, ссылки и визиты можно отобрать по группе. Чтобы забирать только новое, передавайте время прошлого запроса — список вернёт созданное и изменённое с тех пор.

Если связь оборвалась и вы повторяете запрос, передайте в заголовке Idempotency-Key тот же ключ, что в первый раз: Докифай вернёт прежний ответ, а не создаст вторую ссылку или файл.

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

Ограничения

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

Отзыв ключа

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

Что дальше

← Ко всем статьям