# Doodocs People

> Документация по продукту и Developer API Doodocs People

## Руководства

### Начало работы

- [Обзор](https://platform.doodocs.kz/ru/index.md): Developer API Doodocs People: программный доступ к сотрудникам, документам и событиям
- [Быстрый старт](https://platform.doodocs.kz/ru/quickstart.md): Получите Developer API-ключ и сделайте первый запрос

### Сотрудники

- [Модель сотрудника](https://platform.doodocs.kz/ru/guides/employees/model.md): Каноническая карточка сотрудника: поля, redacted_fields и модель доступа
- [Employee-graph](https://platform.doodocs.kz/ru/guides/employees/graph.md): Сотрудник как узел графа: связи и обход через expand
- [Статусы и жизненный цикл](https://platform.doodocs.kz/ru/guides/employees/lifecycle.md): Значения EmployeeStatus и переходы карточки сотрудника

### Документы

- [Документы: обзор и жизненный цикл](https://platform.doodocs.kz/ru/guides/documents/overview.md): Что такое документ, его статусы и структура объекта
- [Шаблоны](https://platform.doodocs.kz/ru/guides/documents/templates.md): Найдите шаблон и прочитайте его variable_schema
- [Загрузка своего документа](https://platform.doodocs.kz/ru/guides/documents/uploads.md): Отправить на подписание PDF, который у вас уже есть
- [Подписание документа](https://platform.doodocs.kz/ru/guides/documents/signing.md): Сквозной путь: создать → маршрут → отправить → подписать → скачать
- [События документов](https://platform.doodocs.kz/ru/guides/documents/events.md): Вебхуки document.* и реакция на смену статуса

### Рецепты

- [Синхронизировать всех сотрудников](https://platform.doodocs.kz/ru/guides/recipes/sync-employees.md): Первичная выгрузка, инкрементальный опрос и сверка удалений
- [Реагировать на приём и увольнение](https://platform.doodocs.kz/ru/guides/recipes/react-to-hire.md): Обрабатывать вебхуки о найме и увольнении сотрудников
- [Отправить документ на подпись](https://platform.doodocs.kz/ru/guides/recipes/sign-a-document.md): Создать приказ, провести по маршруту и получить подписанный PDF

## API Reference

### Обзор

- [Аутентификация](https://platform.doodocs.kz/ru/api-reference/authentication.md): Ключи API, области доступа и модель прав
- [Пагинация](https://platform.doodocs.kz/ru/api-reference/pagination.md): Постраничный обход списков через page_token
- [Ошибки](https://platform.doodocs.kz/ru/api-reference/errors.md): Коды состояния и машиночитаемые коды ошибок
- [Конвенции](https://platform.doodocs.kz/ru/api-reference/conventions.md): Версионирование, форматы, фильтры и совместимость
- [Вебхуки](https://platform.doodocs.kz/ru/api-reference/webhooks.md): Мгновенные уведомления об изменениях данных
- [Ingest](https://platform.doodocs.kz/ru/api-reference/ingest.md): Массовая загрузка оргструктуры: источники, схемы записей, идемпотентность
- [Лимиты](https://platform.doodocs.kz/ru/api-reference/limits.md): Частота запросов, сроки жизни ссылок и вебхук-доставки

### Endpoints

#### ApiKeyService

- [Verify Api Key](https://platform.doodocs.kz/ru/api-reference/endpoints/apikeyservice/verify-api-key.md): Verifies that the supplied Developer API key is accepted for the tenant. Clients can treat a successful response status as proof that the key works.

#### DocumentService

- [List Document Templates](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/list-document-templates.md): Returns the active document templates the key owner can use to create documents. Read a template's variable schema with GetDocumentTemplate before calling CreateDocument.
- [Get Document Template](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/get-document-template.md): Returns a single template by id, including the published version's variable schema — the shape of the template_values map that CreateDocument expects.
- [List Document Type Categories](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/list-document-type-categories.md): Returns the document type categories visible to the key's owner.
- [List Document Types](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/list-document-types.md): Returns the document types (templates catalog) visible to the key's owner.
- [List Documents](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/list-documents.md): Returns documents visible to the key owner in the registry, newest first by default, filtered by status, type, initiator, creation date, and last change. List items carry the document's scalar fields only — files and route are omitted; call GetDocument for those. Note: a document reachable only thro…
- [Create Document](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/create-document.md): Creates a draft document on behalf of the key's owner (the owner becomes the initiator), either from a template (template_id) or from a file the caller uploaded with FileService (file_id). Route and sending are separate steps.
- [Get Document](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/get-document.md): Returns a single document by id, including its files and route. Unknown, out-of-scope, and inaccessible documents are an indistinguishable DOCUMENT_NOT_FOUND.
- [Approve Document](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/approve-document.md): Approves the key owner's active approval step (status ON_APPROVAL). participant_id is the owner's active participant slot from the document's route.
- [Reject Document](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/reject-document.md): Rejects the document at the key owner's active step (status ON_APPROVAL or ON_SIGN). A comment is required.
- [Request Changes](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/request-changes.md): Sends the document back for changes from the key owner's active step (status ON_APPROVAL or ON_SIGN). A comment is required.
- [Revoke Document](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/revoke-document.md): Recalls an in-flight document (status ON_APPROVAL or ON_SIGN), cancelling its route. Requires the cancel capability (initiator or a manager).
- [Send Document](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/send-document.md): Launches a document into its route, transitioning it from DRAFT to ON_APPROVAL or ON_SIGN depending on the first step. Set a draft route with SetDocumentRoute first (or rely on the document type's default policy route).
- [Sign Document](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/sign-document.md): Applies a signature on behalf of the key's owner for one of their active signing slots. Signing is NOT performed server-side: the caller must supply a valid base64 CMS/ЭЦП signature that they produced with their own key (NCALayer or eGov Mobile). The server validates it and records it through the si…
- [Download Document](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/download-document.md): Returns a short-lived, presigned URL to download one of the document's stored files (PDF by default). Access is gated by the same rules as GetDocument.
- [Set Document Route](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/set-document-route.md): Sets the draft route of a document that has not been sent yet. Replaces any existing draft route with the provided steps.
- [Update Document Route](https://platform.doodocs.kz/ru/api-reference/endpoints/documentservice/update-document-route.md): Modifies the route of an in-flight document (status ON_APPROVAL or ON_SIGN). Steps that have already acted are preserved; pending future steps are replaced with the provided ones.

#### EmployeeService

- [List Employees](https://platform.doodocs.kz/ru/api-reference/endpoints/employeeservice/list-employees.md): Returns employees of the key's tenant, newest first. Draft (CREATED) and deleted employees are never returned. Related objects are included only when requested via `expand`.
- [Get Employee](https://platform.doodocs.kz/ru/api-reference/endpoints/employeeservice/get-employee.md): Returns a single employee by id. Unknown, out-of-scope, draft and deleted employees are indistinguishable EMPLOYEE_NOT_FOUND.

#### FileService

- [Create File Upload](https://platform.doodocs.kz/ru/api-reference/endpoints/fileservice/create-file-upload.md): Reserves a file and returns a short-lived presigned POST form to upload it to. Submit the form as multipart/form-data with the returned fields first and the bytes in a trailing `file` part. The upload is unusable until ConfirmFileUpload accepts it.
- [Confirm File Upload](https://platform.doodocs.kz/ru/api-reference/endpoints/fileservice/confirm-file-upload.md): Verifies the bytes reached storage and marks the upload UPLOADED, after which CreateDocument accepts its id. Confirming an already uploaded file is a no-op.

#### IngestService

- [Ingest Records](https://platform.doodocs.kz/ru/api-reference/endpoints/ingestservice/ingest-records.md): Accepts a batch of records for a given source and payload type and enqueues them for asynchronous processing. Returns an ingest request id to correlate the result.

#### LoginService

- [List Login Methods](https://platform.doodocs.kz/ru/api-reference/endpoints/loginservice/list-login-methods.md): Lists enabled authentication methods for the tenant. The `slug` value is used when binding an external person to an authentication identity.

#### WebhookService

- [List Webhook Endpoints](https://platform.doodocs.kz/ru/api-reference/endpoints/webhookservice/list-webhook-endpoints.md): Lists the tenant's webhook endpoints. Secrets are never returned.
- [Create Webhook Endpoint](https://platform.doodocs.kz/ru/api-reference/endpoints/webhookservice/create-webhook-endpoint.md): Registers an https endpoint to receive signed event deliveries. The signing secret is returned once, in the response, and never again.
- [Delete Webhook Endpoint](https://platform.doodocs.kz/ru/api-reference/endpoints/webhookservice/delete-webhook-endpoint.md): Removes a webhook endpoint. Idempotent-safe: an unknown id is WEBHOOK_NOT_FOUND.
- [Update Webhook Endpoint](https://platform.doodocs.kz/ru/api-reference/endpoints/webhookservice/update-webhook-endpoint.md): Changes the delivery url, the subscribed event types, or both. Omitted fields keep their current value; the signing secret is never changed here (use RotateWebhookEndpointSecret).
- [Re-Enable Webhook Endpoint](https://platform.doodocs.kz/ru/api-reference/endpoints/webhookservice/re-enable-webhook-endpoint.md): Clears an auto-disable so an endpoint disabled after repeated delivery failures receives events again, and resets the failure counter. Events that occurred while the endpoint was disabled are not replayed: reconcile by polling before you re-enable.
- [Rotate Webhook Endpoint Secret](https://platform.doodocs.kz/ru/api-reference/endpoints/webhookservice/rotate-webhook-endpoint-secret.md): Issues a new signing secret and returns it once. The previous secret keeps working for grace_seconds so a receiver can switch over without dropping deliveries: during that window every delivery carries the new signature in Doodocs-Signature and the old one in Doodocs-Signature-Previous. Accept eithe…
- [Test Webhook Endpoint](https://platform.doodocs.kz/ru/api-reference/endpoints/webhookservice/test-webhook-endpoint.md): Synchronously delivers a signed ping to the endpoint and returns the HTTP status the receiver responded with (or a connection error). Useful for verifying signature handling before real events flow.

## Changelog

### Обновления

- [Changelog](https://platform.doodocs.kz/ru/changelog/overview.md): Изменения в продукте и Developer API

## OpenAPI Specs

- [openapi](/api-reference/openapi.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English (51 pages)](https://platform.doodocs.kz/_llms/en.md): Documentation for English.