Окружения - Doodocs People

Базовый адрес

https://app.doodocs.kz/api/developer/v1

Все пути в справочнике даны относительно него. Аутентификация — заголовок X-API-Key, заголовок тенанта передавать не нужно: тенант определяет сам ключ.

Отдельного тестового окружения (sandbox) нет. Отлаживайте интеграцию на данных своего тенанта — заведите для этого несколько тестовых сотрудников и черновиков документов.

Включение для тенанта

Developer API закрыт функциональным флагом. Пока он выключен, любой запрос возвращает 403 с кодом FEATURE_FLAG.NOT_AVAILABLE, даже если ключ верный. Включение запрашивается у вашего менеджера Doodocs. Раздел с ключами появляется в приложении там же: Настройки → Интеграции → «Для разработчиков» → API.

Проверка ключа

Прежде чем строить интеграцию, убедитесь, что ключ принят. Эндпоинт ничего не возвращает, кроме статуса, и не требует ни одной области доступа.

curl https://app.doodocs.kz/api/developer/v1/api_key/_verify \
  -H "X-API-Key: $DOODOCS_API_KEY"

{}

Ответ	Что означает
`200`	Ключ активен, тенант определён, флаг включён
`401`	Ключ отсутствует, отозван или неизвестен; либо владельца исключили из тенанта
`403`	Ключ верный, но Developer API для тенанта не включён

Ограничения окружения

Частота — 10 запросов в секунду на ключ, всплеск до 20. Подробнее в Лимитах.
Версия одна — v1. Правила совместимости описаны в Соглашениях.
Исходящие вызовы (вебхуки) идут только на https и только на публичные адреса — см. Безопасность.