X-API-Key.
API в стадии preview: включается по запросу (флаг
developer_api). Внутри v1
только аддитивные изменения — новые поля, значения перечислений и ручки.Ментальная модель
Ключ = тенант + доступ
Ключ привязан к одному тенанту. Эффективный доступ — пересечение областей
ключа и прав владельца; недоступные поля скрываются и перечисляются в
redacted_fields.Сущности
Сотрудники (и employee-graph: отдел, должность, руководитель) и документы —
полный цикл от шаблона до подписанного PDF.
События
Вебхуки
employee.*, person.changed и document.* — реагируйте на
изменения без опроса.Пагинация и ошибки
Списки — через
page_token; ошибки несут строковый code; одиночный ресурс
без доступа неотличим от несуществующего (404).Что доступно сейчас
- Сотрудники — список и карточка с
expand, фильтрами и инкрементальной синхронизацией. → Модель сотрудника - Документы — создание из шаблона или из загруженного PDF, маршруты, отправка, согласование, подписание (ЭЦП/КЭД) и скачивание. → Документы: обзор
- Вебхуки — события по сотрудникам и документам. → Вебхуки
- Ingest — массовая загрузка оргструктуры (область
ingest:write).
С чего начать
Быстрый старт
От ключа до первого ответа за пять минут.
Аутентификация
Ключи
X-API-Key, области доступа и модель прав.Сотрудники
Модель сотрудника, employee-graph и синхронизация.
Документы
Создать, направить по маршруту, подписать и скачать.