Кадровые понятия
Человек (person) — физическое лицо: ФИО, ИИН, личные контакты. Один человек может иметь несколько карточек сотрудника в разных организациях тенанта. Сотрудник (employee) — карточка человека в конкретном тенанте: должность, подразделение, статус, даты. Центральный ресурс API. Тенант — организация-клиент Doodocs People со своими сотрудниками, документами и настройками. Ключ API привязан ровно к одному тенанту. ИИН — индивидуальный идентификационный номер физического лица в Казахстане, 12 цифр. Используется как юридический идентификатор при подписании. БИН — бизнес-идентификационный номер юридического лица, 12 цифр. Аналог ИИН для организаций.Документы
Тип документа — справочная сущность: приказ о приёме, заявление на отпуск и так далее. Задаёт шаблон, субъекта и конфиденциальность. Шаблон — печатная форма с набором переменных (variable_schema), из которой
генерируется документ.
Субъект документа — сотрудник, о котором документ. Не путать с инициатором:
инициатор создаёт документ, субъект в нём фигурирует.
Маршрут — последовательность шагов согласования и подписания. Шаг содержит
участников и правило прохождения.
Участник (participant) — слот в шаге маршрута, закреплённый за конкретным
сотрудником. Действия выполняются от имени слота, а не от имени человека.
Подписание
ЭЦП — электронная цифровая подпись. В Казахстане выдаётся Национальным удостоверяющим центром и хранится в виде пары ключей. КЭД — карточка электронного документа: сводка о документе и его подписях, которую можно скачать отдельным файлом (FILE_TYPE_DDCARD).
КЭДО — кадровый электронный документооборот: перевод кадровых документов в
электронную форму с юридически значимой подписью.
CMS — формат подписи (Cryptographic Message Syntax), в котором ЭЦП
передаётся в API. Кодируется в base64.
NCALayer — настольная программа Национального удостоверяющего центра,
формирующая подпись на компьютере пользователя.
eGov Mobile — мобильное приложение государственных услуг Казахстана,
позволяющее подписать документ с телефона.
Термины API
Область доступа (scope) — метка на ключе, разрешающая группу эндпоинтов:employees:read, documents:write и другие.
Редакция полей (redacted_fields) — список полей, скрытых от владельца
ключа его правами. Пустое значение поля и его отсутствие в ответе — разные вещи.
page_token — непрозрачный курсор пагинации. Привязан к набору фильтров,
для которого выдан.
expand — параметр, подгружающий связанные сущности в ответ, чтобы не
делать отдельный запрос за каждой.