Skip to main content
Пройдём весь путь на живом примере: ТОО «Керуен» выпускает приказ о приёме на работу для Куляш Байсеитовой, отправляет его на подпись руководителю Ахмету Байтурсынову и скачивает готовый PDF.
Чтение справочников и документа требует области documents:read, а создание, маршрут, отправка и подпись — documents:write.
1

Выберите шаблон

Найдите активный шаблон приказа и запомните template_id и template_version. Схему переменных (variable_schema) для template_values возьмите из карточки шаблона — подробнее в руководстве по шаблонам.
2

Создайте документ

Соберите документ из шаблона. Значения в template_values должны соответствовать variable_schema, а получатель приказа задаётся в subject_employee_ids. Инициатором станет сотрудник — владелец ключа (определяется сервером, подменить нельзя).
В ответе придёт документ со статусом DOCUMENT_STATUS_DRAFT и его id.
3

Задайте маршрут подписания

Черновику нужен маршрут. Для приказа достаточно одного шага подписания, назначенного на руководителя Ахмета Байтурсынова.
Документ остаётся в DOCUMENT_STATUS_DRAFT — маршрут пока только описан.
4

Отправьте по маршруту

Запустите маршрут. По умолчанию initial_action = SEND_INITIAL_ACTION_SEND_ONLY: документ уходит подписанту, а статус переходит в DOCUMENT_STATUS_ON_SIGN.
5

Подпишите

Подпись всегда формируется на стороне клиента: сервер её только проверяет и записывает. Ахмет подписывает своим ключом через NCALayer (десктоп) или eGov Mobile, получает готовую base64 CMS/ЭЦП и передаёт её в _sign.participant_id — это идентификатор активного слота подписанта; возьмите его из route.steps[].participants[].id, прочитав документ через GET /documents/{id}.
Как получить base64-подпись из NCALayer или eGov Mobile — в руководстве по подписанию. Здесь важно одно: готовую ЭЦП вы передаёте в signature, а сервер её валидирует.
Когда подписан последний требуемый шаг, документ переходит в DOCUMENT_STATUS_COMPLETED.
6

Скачайте подписанный PDF

Для завершённого документа запросите presigned-ссылку на итоговый файл.
В ответе — временная ссылка на подписанный PDF. Другие представления доступны через file_type: FILE_TYPE_PREVIEW (печатная форма), FILE_TYPE_DDCARD (карточка КЭД), FILE_TYPE_DOCX, FILE_TYPE_JSON.

Жизненный цикл

Отклонение переводит документ в DOCUMENT_STATUS_REJECTED, запрос правок — в DOCUMENT_STATUS_CHANGE_REQUESTED, отзыв инициатором — в DOCUMENT_STATUS_REVOKED.

Узнавать о завершении

Чтобы не опрашивать статус, подпишитесь на событие document.completed и скачивайте PDF по факту. События документов приходят по каждому документу тенанта и несут только document_id и тайминги — не содержимое; доступ по-прежнему проверяет GET /documents/{id}.

Дальше

Подписание

NCALayer, eGov Mobile и формирование base64-ЭЦП.

Шаблоны документов

Как читать variable_schema и заполнять template_values.