Публичная документацияAPI v1
API-first платформа

ОРДОО API

Единый JSON API независимого реестра. Здесь опубликованы только пользовательские операции и документация официального процедурного PHP SDK. Административные функции не раскрываются в публичном каталоге.

Смотреть endpointsПроверить healthOpenAPI YAML

Единый контракт

Все API-операции принимают и возвращают JSON. Каждый ответ содержит HTTP status, шестизначный result_code и обязательный request_id.

{
  "success": true,
  "http_code": 200,
  "result_code": "010013",
  "message": "Данные текущего пользователя загружены.",
  "data": {},
  "errors": [],
  "meta": { "request_id": "...", "timestamp": "..." }
}

Публичные endpoints

Base URL: https://api.ordoo.ru. Пользовательский access token передается в Authorization: Bearer.

GET/health.php

Состояние API

Проверяет готовность runtime, конфигурации, storage и базы данных без раскрытия внутренних сведений.

Авторизация Не требуется
Успех 000002
Ошибки 000001, 000003
SDK-файл health.php
Функция ordoo_sdk_health()
POST/v1/email/verify.php

Подтверждение email

Погашает одноразовый token и подтверждает основной email.

token — строка из защищённой ссылки
Авторизация Одноразовый token в JSON
Успех 130001
Ошибки 130005, 130007
SDK-файл v1/email/verify.php
Функция ordoo_sdk_email_verify()
POST/v1/email/marketingOptOut.php

Отключение маркетинга

Идемпотентно отключает только маркетинговые письма, не затрагивая транзакционные.

Авторизация Authorization: Bearer
Успех 130009
Ошибки 010005, 130007
SDK-файл v1/email/marketingOptOut.php
Функция ordoo_sdk_email_marketing_opt_out()
POST/v1/api-key/create.php

Выпуск API-ключа

Создает ключ подтвержденной организации. Полное значение возвращается один раз, в БД хранится только SHA-256 hash.

organization_id — публичный ID
name — название ключа
permissions — document.webhook.create
ip_rules — до 32 IP/CIDR
rate_limit_per_minute — 1–10000
expires_at — необязательная будущая дата
confirm — true
Авторизация Authorization: Bearer + organization.api.manage
Успех 040001
Ошибки 040006, 040007, 040008, 040013
SDK-файл v1/api-key/create.php
Функция ordoo_sdk_api_key_create()
GET/v1/api-key/list.php

API-ключи организации

Возвращает только безопасные metadata, prefix, permissions, IP и статус без raw/hash.

organization_id — публичный ID в query
Авторизация Authorization: Bearer + organization.api.manage
Успех 040002
Ошибки 040007, 040008, 040013
SDK-файл v1/api-key/list.php
Функция ordoo_sdk_api_key_list()
POST/v1/api-key/suspend.php

Приостановка ключа

Приостанавливает ключ с обязательной причиной.

organization_id — публичный ID
id — ID ключа
reason — причина
confirm — true
Авторизация Authorization: Bearer + organization.api.manage
Успех 040003
Ошибки 040006, 040007, 040008, 040009, 040013
SDK-файл v1/api-key/suspend.php
Функция ordoo_sdk_api_key_suspend()
POST/v1/api-key/resume.php

Возобновление ключа

Возобновляет неистекший и неотозванный ключ.

organization_id — публичный ID
id — ID ключа
reason — необязательная причина
confirm — true
Авторизация Authorization: Bearer + organization.api.manage
Успех 040004
Ошибки 040006, 040007, 040008, 040009, 040013
SDK-файл v1/api-key/resume.php
Функция ordoo_sdk_api_key_resume()
POST/v1/api-key/revoke.php

Отзыв ключа

Безвозвратно отзывает ключ с причиной; запись не удаляется.

organization_id — публичный ID
id — ID ключа
reason — причина
confirm — true
Авторизация Authorization: Bearer + organization.api.manage
Успех 040005
Ошибки 040006, 040007, 040008, 040009, 040013
SDK-файл v1/api-key/revoke.php
Функция ordoo_sdk_api_key_revoke()
GET/v1/webhook/document/create.php

Входящий документ

Идемпотентно создает документ организации только в submitted/pending из параметров HTTPS URL после проверки API-ключа, IP, rate limit, permission и webhook-канала тарифа. ID события формируется сервером из канонически отсортированного запроса.

api_key — API-ключ организации
event — document.created
document[type] — код вида из управляемого селектора
document[issue_date] — ISO, YYYY/MM/DD, DD.MM.YYYY, DD/MM/YYYY, DD-MM-YYYY или Unix timestamp
document[field] — реквизиты, holder и program без системных статусов
Авторизация api_key в query string HTTPS URL
Успех 110001
Ошибки 110002, 110003, 110004, 110007, 110009, 050012, 050013, 050014, 050015, 050019, 050020
SDK-файл v1/webhook/document/create.php
Функция ordoo_sdk_webhook_document_create()
GET/v1/organization/import/template.php

Шаблон XLSX

Возвращает готовую таблицу XLSX с обязательными колонками и примером строки.

Авторизация Authorization: Bearer + organization.import.manage
Успех 120010
Ошибки 120006, 120009
SDK-файл v1/organization/import/template.php
Функция ordoo_sdk_organization_import_template()
POST/v1/organization/import/create.php

Предпросмотр XLSX

Проверяет таблицу XLSX до 10 МБ и создает staging с row-level ошибками без документов.

organization_id — публичный ID
filename — имя .xlsx
content_base64 — байты XLSX
Авторизация Authorization: Bearer + organization.import.manage
Успех 120001
Ошибки 120005, 120006, 120009
SDK-файл v1/organization/import/create.php
Функция ordoo_sdk_organization_import_create()
GET/v1/organization/import/get.php

Отчёт импорта

Возвращает summary и row-level отчёт без staging PII.

organization_id — публичный ID
id — ID импорта
Авторизация Authorization: Bearer + organization.import.manage
Успех 120002
Ошибки 120006, 120007, 120009
SDK-файл v1/organization/import/get.php
Функция ordoo_sdk_organization_import_get()
POST/v1/organization/import/confirm.php

Подтверждение импорта

После одного подтверждения ставит полностью валидный preview в очередь; frontend либо HTTP worker автоматически обрабатывает строки короткими ограниченными транзакционными пачками.

organization_id — публичный ID
id — ID импорта
confirm — true
Авторизация Authorization: Bearer + organization.import.manage
Успех 120003
Ошибки 120006, 120007, 120008, 120009
SDK-файл v1/organization/import/confirm.php
Функция ordoo_sdk_organization_import_confirm()
POST/v1/organization/import/process.php

Обработка пачки

Обрабатывает ограниченную пачку только выбранной организации; документы получают submitted/pending и не расходуют лимит до решения модератора.

organization_id — публичный ID
limit — целое 1–100
Авторизация Authorization: Bearer + organization.import.manage
Успех 120004
Ошибки 120005, 120006, 120009
SDK-файл v1/organization/import/process.php
Функция ordoo_sdk_organization_import_process()
GET/v1/organization/analytics/get.php

Аналитика организации

Возвращает изолированные агрегаты документов, ФИС ФРДО, каналов и тарифных остатков без PII.

organization_id — публичный ID
date_from — YYYY-MM-DD
date_to — YYYY-MM-DD
Авторизация Authorization: Bearer + organization.analytics.view
Успех 090030
Ошибки 090029, 090033, 020014, 020016
SDK-файл v1/organization/analytics/get.php
Функция ordoo_sdk_organization_analytics_get()
POST/v1/analytics/visit.php

Посещение страницы

Идемпотентно фиксирует обезличенное посещение по случайным visitor/session ID и группе страницы; Bearer связывает событие с зарегистрированным пользователем.

visitor_id — случайный ID браузера
session_id — случайный ID сессии
event_id — уникальный ID события
page_group — нормализованная группа страницы
Авторизация Не требуется; Authorization: Bearer необязателен
Успех 090037
Ошибки 090034, 090035, 090036
SDK-файл v1/analytics/visit.php
Функция ordoo_sdk_analytics_visit()
POST/v1/user/register.php

Регистрация

Создает обычную учетную запись, сохраняет email неподтвержденным и ставит письмо подтверждения в очередь.

email — string, email, до 320 символов
password — string, от 12 символов и минимум три категории
Авторизация Не требуется
Успех 010001
Ошибки 010014, 010015, 010016, 010019
SDK-файл v1/user/register.php
Функция ordoo_sdk_auth_register()
POST/v1/user/login.php

Вход

Проверяет credentials и возвращает токены только активной записи. При верном пароле заблокированной записи сообщает отдельный статус без выдачи доступа.

email — string, email
password — string
Авторизация Не требуется
Успех 010002
Ошибки 010003, 010004, 010014, 010016, 010019, 010045
SDK-файл v1/user/login.php
Функция ordoo_sdk_auth_login()
POST/v1/user/refresh.php

Обновление токенов

Погашает текущий refresh token и возвращает новую пару. Повторное использование отзывает семейство.

refresh_token — string, полученный при login/refresh
Авторизация Refresh token в JSON
Успех 010006
Ошибки 010005, 010007, 010016, 010019
SDK-файл v1/user/refresh.php
Функция ordoo_sdk_auth_refresh()
POST/v1/user/logout.php

Выход

Отзывает текущий access token, серверную сессию и связанные refresh tokens.

Авторизация Authorization: Bearer
Успех 010008
Ошибки 010005, 010016, 010019
SDK-файл v1/user/logout.php
Функция ordoo_sdk_auth_logout()
GET/v1/user/get.php

Текущий пользователь

Возвращает публичный ID, email, роли и permissions текущей учетной записи.

Авторизация Authorization: Bearer
Успех 010013
Ошибки 010005, 010016, 010019
SDK-файл v1/user/get.php
Функция ordoo_sdk_auth_user_get()
POST/v1/user/passwordRequestReset.php

Запрос восстановления

Принимает запрос без раскрытия существования email и ставит письмо восстановления в очередь.

email — string, email
Авторизация Не требуется
Успех 010009
Ошибки 010016, 010019
SDK-файл v1/user/passwordRequestReset.php
Функция ordoo_sdk_auth_password_reset_request()
POST/v1/user/passwordReset.php

Смена пароля

Проверяет одноразовый reset token, меняет password hash и отзывает прежние сессии.

token — string, одноразовый reset token
new_password — string, новый безопасный пароль
Авторизация Reset token в JSON
Успех 010010
Ошибки 010011, 010016, 010019
SDK-файл v1/user/passwordReset.php
Функция ordoo_sdk_auth_password_reset()
GET/v1/user/profile/get.php

Профиль пользователя

Возвращает владельцу анкету, расшифрованный паспорт, страновые маски, метаданные аватара, файлов текущего цикла и историю проверки.

Авторизация Authorization: Bearer
Успех 010020
Ошибки 010005, 010031, 010032
SDK-файл v1/user/profile/get.php
Функция ordoo_sdk_user_profile_get()
POST/v1/user/profile/update.php

Анкета пользователя

Сохраняет единую страну профиля, ФИО, дату рождения, международный телефон этой страны и обязательный СНИЛС до отправки или после возврата. Ошибка 010029 содержит безопасный errors[] с конкретными полями.

first_name — имя
last_name — фамилия
middle_name — отчество, необязательно
birth_date — YYYY-MM-DD
country_code — единая страна телефона, паспорта и правил документов; ISO alpha-2
phone — полный телефон выбранной страны
snils — обязательно, 11 цифр; checksum применяется с учетом исторического диапазона
Авторизация Authorization: Bearer
Успех 010021
Ошибки 010029, 010030, 010032
SDK-файл v1/user/profile/update.php
Функция ordoo_sdk_user_profile_update()
POST/v1/user/profile/passportUpdate.php

Паспортные данные

Проверяет реквизиты паспорта по уже сохраненной стране профиля и хранит их только в зашифрованном AES-256-GCM payload. Ошибка 010029 содержит безопасный errors[] с конкретными полями.

country_code — должен совпадать с единой страной сохраненной анкеты
series — отдельная серия, если предусмотрена страной
number — номер по формату страны
issue_date — YYYY-MM-DD
issued_by — кем выдан
division_code — только РФ, 6 цифр
birth_place — место рождения
registration_address — обязательно для РФ
Авторизация Authorization: Bearer
Успех 010022
Ошибки 010029, 010030, 010032
SDK-файл v1/user/profile/passportUpdate.php
Функция ordoo_sdk_user_profile_passport_update()
POST/v1/user/profile/fileUpload.php

Файл верификации

Принимает JPEG, PNG или PDF до 8 МБ в base64 и сохраняет под случайным именем в закрытом storage.

purpose — passport_main, passport_registration, snils_proof или identity_extra
filename — исходное имя
content_base64 — содержимое файла
Авторизация Authorization: Bearer
Успех 010023
Ошибки 010029, 010030, 010032
SDK-файл v1/user/profile/fileUpload.php
Функция ordoo_sdk_user_profile_file_upload()
POST/v1/user/profile/fileDownload.php

Получение файла

Возвращает владельцу собственный файл в base64 после проверки SHA-256.

file_id — публичный ID файла
Авторизация Authorization: Bearer
Успех 010024
Ошибки 010031, 010032
SDK-файл v1/user/profile/fileDownload.php
Функция ordoo_sdk_user_profile_file_download()
POST/v1/user/profile/avatarUpload.php

Аватар пользователя

Принимает JPEG, PNG или WebP до 4 МБ и заменяет собственный аватар пользователя.

content_base64 — изображение от 128 × 128 до 4096 × 4096 px
Авторизация Authorization: Bearer
Успех 010033
Ошибки 010029, 010032
SDK-файл v1/user/profile/avatarUpload.php
Функция ordoo_sdk_user_profile_avatar_upload()
GET/v1/user/profile/avatarDownload.php

Получение аватара

Возвращает владельцу собственный аватар в base64 после проверки SHA-256.

Авторизация Authorization: Bearer
Успех 010034
Ошибки 010031, 010032
SDK-файл v1/user/profile/avatarDownload.php
Функция ordoo_sdk_user_profile_avatar_download()
POST/v1/user/profile/startReverification.php

Изменение подтвержденных данных

По явной причине снимает статус verified, создает новый изолированный цикл файлов и открывает данные для повторной проверки.

reason — причина от 10 до 500 символов
Авторизация Authorization: Bearer
Успех 010035
Ошибки 010029, 010030, 010032
SDK-файл v1/user/profile/startReverification.php
Функция ordoo_sdk_user_profile_start_reverification()
POST/v1/user/profile/submitVerification.php

Отправка на проверку

Требует полную анкету со СНИЛС, паспорт и файлы текущего цикла; для РФ обязательны passport_main, passport_registration и snils_proof. Ошибка 010029 перечисляет каждый отсутствующий документ в безопасном errors[].

Авторизация Authorization: Bearer
Успех 010025
Ошибки 010029, 010030, 010032
SDK-файл v1/user/profile/submitVerification.php
Функция ordoo_sdk_user_profile_submit_verification()
GET/v1/organization/typeList.php

Типы организаций

Возвращает активный управляемый справочник типов организаций без внутренних ID.

Авторизация Authorization: Bearer
Успех 020047
Ошибки 010005, 020016, 020017
SDK-файл v1/organization/typeList.php
Функция ordoo_sdk_organization_type_list()
POST/v1/organization/create.php

Черновик организации

Создает редактируемый draft с официальными наименованиями и owner-членство. Публичная ссылка строится по возвращенному id; при 020012 или конфликте ИНН errors содержит field, code и message.

organization_type_code — активный код управляемого справочника
full_name — полное официальное наименование
short_name — краткое официальное наименование
inn — 10 или 12 цифр
ogrn — необязательно, 13 или 15 цифр
Авторизация Authorization: Bearer
Успех 020035
Ошибки 020012, 020015, 020016, 020017
SDK-файл v1/organization/create.php
Функция ordoo_sdk_organization_create()
POST/v1/organization/submit.php

Первая отправка организации

Переводит заполненный draft с документом государственной регистрации в pending.

id — публичный ID организации
Авторизация Authorization: Bearer
Успех 020036
Ошибки 020012, 020013, 020014, 020015, 020027
SDK-файл v1/organization/submit.php
Функция ordoo_sdk_organization_submit()
POST/v1/organization/delete.php

Удаление черновика

Окончательно удаляет организацию владельца только до первой отправки, включая закрытые файлы, и освобождает ИНН.

id — публичный ID организации
Авторизация Authorization: Bearer
Успех 020037
Ошибки 020012, 020013, 020014, 020015
SDK-файл v1/organization/delete.php
Функция ordoo_sdk_organization_delete()
GET/v1/organization/list.php

Организации пользователя

Возвращает все активные членства текущего пользователя, отдельную роль, permissions, статус и количество сотрудников.

Авторизация Authorization: Bearer
Успех 020019
Ошибки 010005, 020016, 020017
SDK-файл v1/organization/list.php
Функция ordoo_sdk_organization_list()
GET/v1/organization/get.php

Карточка сотрудника

Возвращает профиль с официальными наименованиями, отдельные лицензии, регистрационные файлы, роль и permissions активного сотрудника.

id — необязательный публичный ID в query
Авторизация Authorization: Bearer
Успех 020002
Ошибки 010005, 020013, 020016, 020017
SDK-файл v1/organization/get.php
Функция ordoo_sdk_organization_get()
POST/v1/organization/update.php

Изменение карточки

Изменяет профиль вне pending. Измененная verified-карточка возвращается в pending; лицензии этой операцией не меняются.

id — публичный ID организации
organization_type_code — активный или уже сохраненный код типа
full_name — полное официальное наименование
short_name — краткое официальное наименование
show_contacts — явное согласие на публичные контакты
Авторизация Authorization: Bearer
Успех 020003
Ошибки 020012, 020013, 020014, 020015, 020016, 020017
SDK-файл v1/organization/update.php
Функция ordoo_sdk_organization_update()
POST/v1/organization/logoUpload.php

Логотип организации

Принимает JPEG, PNG или WebP до 4 МБ и заменяет логотип организации при праве изменения профиля. Чужая карточка и отсутствие права скрываются единым not found.

id — публичный ID организации
content_base64 — изображение от 128 × 128 до 4096 × 4096 px
Авторизация Authorization: Bearer + organization.profile.update
Успех 020048
Ошибки 020012, 020013, 020016
SDK-файл v1/organization/logoUpload.php
Функция ordoo_sdk_organization_logo_upload()
GET/v1/organization/logoDownload.php

Получение логотипа организации

Возвращает доступному сотруднику логотип в base64 после проверки размера и SHA-256.

id — публичный ID организации в query
Авторизация Authorization: Bearer
Успех 020049
Ошибки 020013, 020016
SDK-файл v1/organization/logoDownload.php
Функция ordoo_sdk_organization_logo_download()
GET/v1/organization/educationActivityList.php

Виды образовательной деятельности

Возвращает 21 укрупненный вид программ из приложения к ПП РФ № 1490 без внутренних ID.

Авторизация Authorization: Bearer
Успех 020022
Ошибки 010005, 020016, 020017
SDK-файл v1/organization/educationActivityList.php
Функция ordoo_sdk_organization_education_activity_list()
POST/v1/organization/license/create.php

Добавление лицензии

Создает новую pending-лицензию после первой отправки организации. Во время модерации организации запись сохраняется, но появляется в административной очереди лицензий только после подтверждения организации.

id — публичный ID организации
license_number — номер лицензии
issued_at — дата предоставления YYYY-MM-DD
issuing_authority — лицензирующий орган
activity_details — профессии, специальности и адреса
education_activity_codes — минимум один код справочника
Авторизация Authorization: Bearer
Успех 020028
Ошибки 020012, 020013, 020014, 020015, 020016
SDK-файл v1/organization/license/create.php
Функция ordoo_sdk_organization_license_create()
POST/v1/organization/license/update.php

Изменение лицензии

Изменяет pending, возвращенную или отклоненную лицензию. Подтвержденная лицензия неизменяема.

id — публичный ID организации
license_id — публичный ID лицензии
license_number — номер лицензии
issued_at — дата предоставления YYYY-MM-DD
education_activity_codes — минимум один код справочника
Авторизация Authorization: Bearer
Успех 020029
Ошибки 020012, 020013, 020014, 020016, 020033
SDK-файл v1/organization/license/update.php
Функция ordoo_sdk_organization_license_update()
POST/v1/organization/fileUpload.php

Юридический файл организации

Загружает отдельную страницу регистрации либо конкретной неподтвержденной лицензии; JPEG, PNG или PDF до 8 МБ.

id — публичный ID организации
purpose — registration_document или education_license
license_id — обязателен только для education_license
filename — исходное имя
content_base64 — содержимое файла
Авторизация Authorization: Bearer
Успех 020023
Ошибки 020012, 020013, 020014, 020015, 020016, 020033
SDK-файл v1/organization/fileUpload.php
Функция ordoo_sdk_organization_file_upload()
POST/v1/organization/fileDownload.php

Получение юридического файла

Возвращает доступному сотруднику одну страницу в base64 после проверки размера и SHA-256.

file_id — публичный ID файла
Авторизация Authorization: Bearer
Успех 020024
Ошибки 020013, 020016
SDK-файл v1/organization/fileDownload.php
Функция ordoo_sdk_organization_file_download()
POST/v1/organization/fileRemove.php

Удаление юридического файла

Мягко удаляет регистрационный файл или файл неподтвержденной лицензии. Файл подтвержденной лицензии неизменяем.

id — публичный ID организации
file_id — публичный ID файла
Авторизация Authorization: Bearer
Успех 020025
Ошибки 020012, 020013, 020014, 020016, 020033
SDK-файл v1/organization/fileRemove.php
Функция ordoo_sdk_organization_file_remove()
POST/v1/organization/submitCorrection.php

Повторная отправка

Переводит собственную исправленную карточку из correction_requested или rejected в pending с неизменяемой историей и audit log.

id — публичный ID организации
Авторизация Authorization: Bearer
Успех 020020
Ошибки 020012, 020013, 020014, 020015, 020016, 020017
SDK-файл v1/organization/submitCorrection.php
Функция ordoo_sdk_organization_submit_correction()
POST/v1/organization/member/add.php

Добавление сотрудника

Добавляет уже зарегистрированного пользователя с не-owner ролью при permission organization.members.manage.

id — публичный ID организации
email — email существующего пользователя
role — системный код организационной роли
Авторизация Authorization: Bearer
Успех 020004
Ошибки 020012, 020014, 020015, 020018
SDK-файл v1/organization/member/add.php
Функция ordoo_sdk_organization_member_add()
POST/v1/organization/member/update.php

Роль сотрудника

Изменяет роль активного сотрудника. Роль владельца этой операцией не назначается и не изменяется.

id — публичный ID организации
member_id — публичный ID пользователя
role — новая не-owner роль
Авторизация Authorization: Bearer
Успех 020005
Ошибки 020012, 020014, 020018
SDK-файл v1/organization/member/update.php
Функция ordoo_sdk_organization_member_update()
POST/v1/organization/member/remove.php

Удаление сотрудника

Мягко отзывает членство. Владелец не может быть удален обычной операцией.

id — публичный ID организации
member_id — публичный ID пользователя
Авторизация Authorization: Bearer
Успех 020006
Ошибки 020012, 020014, 020018
SDK-файл v1/organization/member/remove.php
Функция ordoo_sdk_organization_member_remove()
GET/v1/organization/publicGet.php

Публичная карточка

Возвращает только подтвержденную карточку с формализованным типом организации. ИНН, ОГРН и сотрудники не публикуются; контакты выводятся только при явном согласии.

id — неизменяемый 32-символьный публичный ID в query
Авторизация Не требуется
Успех 020007
Ошибки 020012, 020013, 020016, 020017
SDK-файл v1/organization/publicGet.php
Функция ordoo_sdk_organization_public_get()
GET/v1/document/typeList.php

Виды документов об образовании

Возвращает активный формализованный справочник видов документов без внутренних ID.

Авторизация Authorization: Bearer
Успех 030036
Ошибки 010005, 030017, 030018
SDK-файл v1/document/typeList.php
Функция ordoo_sdk_document_type_list()
POST/v1/document/create.php

Личный черновик документа

Создает личный черновик подтвержденного пользователя с обязательным snapshot организации-выдавшей. Статус ФИС ФРДО всегда pending («На проверке»).

source_type — только holder_manual
issuer_name — официальное наименование организации-выдавшей
issuer_inn — ИНН из 10 или 12 цифр
issuer_ogrn — необязательный ОГРН/ОГРНИП
document_type_code — активный код формализованного справочника
series — необязательно
number — номер документа
issued_at — YYYY-MM-DD
registration_number — регистрационный номер
program_name — название программы
Авторизация Authorization: Bearer
Успех 030001
Ошибки 030013, 030017, 030030, 030038
SDK-файл v1/document/create.php
Функция ordoo_sdk_document_create()
GET/v1/document/list.php

Личные документы

Возвращает расширенные карточки личных и связанных по подтвержденному СНИЛС документов: реквизиты, программу, источник, ФИС ФРДО, число файлов и display-даты. Ожидающий отзыв отображается отдельным признаком, а подтвержденно отозванная запись исключается.

q — необязательный поиск до 100 символов
status — общий статус документа
source — personal или organization
document_type_code — код вида из управляемого справочника
frdo_status — pending, not_registered или registered
sort — created_at, issued_at, document_type, status, organization или program
direction — asc или desc
Авторизация Authorization: Bearer
Успех 030003
Ошибки 010005, 030013, 030017, 030018
SDK-файл v1/document/list.php
Функция ordoo_sdk_document_list()
GET/v1/organization/document/list.php

Документы организации

Возвращает документы одной явно выбранной организации с безопасным поиском и сортировкой отображаемой таблицы.

organization_id — публичный ID организации в query
q — необязательный поиск до 100 символов
sort — document_type, number, holder, issued_at, registration_number, status или created_at
direction — asc или desc
Авторизация Authorization: Bearer + organization.documents.view
Успех 030032
Ошибки 030013, 030014, 030017
SDK-файл v1/organization/document/list.php
Функция ordoo_sdk_organization_document_list()
POST/v1/organization/document/create.php

Черновик документа организации

Создает организационный документ от официальной организации с выбранным подтвержденным получателем либо с ручным снимком и СНИЛС; начальный статус ФИС ФРДО всегда pending.

organization_id — публичный ID организации
recipient_user_id — необязательный публичный ID предложенного подтвержденного пользователя
holder_last_name — фамилия при ручном вводе
holder_first_name — имя при ручном вводе
holder_birth_date — дата рождения при ручном вводе
holder_snils — СНИЛС при ручном вводе
document_type_code — активный код формализованного справочника
number — номер документа
issued_at — YYYY-MM-DD
registration_number — регистрационный номер
program_name — название программы
Авторизация Authorization: Bearer + organization.documents.manage
Успех 030033
Ошибки 030013, 030014, 030015, 030016, 030017
SDK-файл v1/organization/document/create.php
Функция ordoo_sdk_organization_document_create()
GET/v1/document/get.php

Карточка документа

Возвращает владельцу реквизиты, программу, метаданные закрытых файлов, общий статус, ожидающую заявку на отзыв, read-only статус ФРДО и историю общих переходов. После подтвержденного отзыва личный доступ прекращается.

id — публичный ID в query
Авторизация Authorization: Bearer
Успех 030002
Ошибки 030013, 030014, 030017
SDK-файл v1/document/get.php
Функция ordoo_sdk_document_get()
POST/v1/document/update.php

Изменение документа

Изменяет только draft или needs_correction. Источник, trust level, общий и ФРДО-статусы не принимаются.

id — публичный ID
document_type_code — активный или уже сохраненный код вида
series — необязательно
number — номер документа
issued_at — YYYY-MM-DD
registration_number — регистрационный номер
program_name — программа
Авторизация Authorization: Bearer
Успех 030004
Ошибки 030013, 030014, 030016, 030017, 030030
SDK-файл v1/document/update.php
Функция ordoo_sdk_document_update()
POST/v1/document/fileUpload.php

Файл документа

Принимает JPEG, PNG или PDF до 8 МБ и сохраняет под случайным именем в закрытом storage только для редактируемого документа.

id — публичный ID документа
purpose — document_scan, supplement или supporting_material
filename — исходное имя
content_base64 — байты файла
Авторизация Authorization: Bearer
Успех 030005
Ошибки 030013, 030014, 030016, 030017
SDK-файл v1/document/fileUpload.php
Функция ordoo_sdk_document_file_upload()
POST/v1/document/fileDownload.php

Получение файла документа

Возвращает доступный владельцу файл в base64 после проверки размера и SHA-256.

id — публичный ID документа
file_id — публичный ID файла
Авторизация Authorization: Bearer
Успех 030006
Ошибки 030013, 030014, 030017
SDK-файл v1/document/fileDownload.php
Функция ordoo_sdk_document_file_download()
POST/v1/document/fileRemove.php

Удаление файла документа

Мягко удаляет файл только у draft или needs_correction и удаляет закрытые физические байты.

id — публичный ID документа
file_id — публичный ID файла
Авторизация Authorization: Bearer
Успех 030007
Ошибки 030013, 030014, 030016, 030017
SDK-файл v1/document/fileRemove.php
Функция ordoo_sdk_document_file_remove()
POST/v1/document/submit.php

Отправка на модерацию

Переводит заполненный draft или needs_correction только в submitted после проверки подходящего оплаченного права. Переход в registered выполняет исключительно назначенный модератор.

id — публичный ID документа
Авторизация Authorization: Bearer
Успех 030020
Ошибки 030013, 030014, 030016, 030019, 030030, 050012, 050013, 050014, 050015, 050019, 050020
SDK-файл v1/document/submit.php
Функция ordoo_sdk_document_submit()
POST/v1/document/suspend.php

Приостановка документа

Переводит доступный источнику registered-документ в suspended с обязательной причиной и неизменяемой историей.

id — публичный ID документа
reason — обязательная причина
Авторизация Authorization: Bearer
Успех 030008
Ошибки 030013, 030014, 030016, 030017
SDK-файл v1/document/suspend.php
Функция ordoo_sdk_document_suspend()
POST/v1/document/revoke.php

Заявка на отзыв документа

Создает обязательную заявку модератору для доступного источнику registered или suspended документа. До решения документ сохраняет действующий статус и виден получателю с признаком ожидания; окончательный revoked устанавливает только модератор.

id — публичный ID документа
reason — обязательная причина
Авторизация Authorization: Bearer
Успех 030040
Ошибки 030013, 030014, 030016, 030017
SDK-файл v1/document/revoke.php
Функция ordoo_sdk_document_revoke()
POST/v1/document/verify.php

Проверка документа

По точному случайному коду возвращает только ранее зарегистрированную запись с маскированными реквизитами, источником, уровнем доверия и точным статусом ФИС ФРДО.

verification_code — ORDOO-XXXX-XXXX-XXXX
client_session — необязательный необратимый frontend-признак
client_fingerprint — необязательный технический fingerprint
captcha_token — token подключенного CAPTCHA hook после порога
client_network — необязательный необратимый frontend-признак сети
Авторизация Не требуется
Успех 140001
Ошибки 140002, 140003, 140004, 140005, 140006, 140007
SDK-файл v1/document/verify.php
Функция ordoo_sdk_document_verify()
GET/v1/tariff/list.php

Каталог тарифов

Возвращает активные продукты и текущие версии цен личного либо доступного организационного финансового контура.

organization_id — необязательный публичный ID организации
Авторизация Authorization: Bearer
Успех 050021
Ошибки 050034, 050035, 050036, 050038, 050039
SDK-файл v1/tariff/list.php
Функция ordoo_sdk_tariff_list()
GET/v1/tariff/get.php

Карточка тарифа

Возвращает один активный продукт с ценой, лимитом, сроком, каналами и ограничениями видов.

id — публичный ID тарифа
organization_id — необязательный публичный ID организации
Авторизация Authorization: Bearer
Успех 050022
Ошибки 050034, 050035, 050036, 050038, 050039
SDK-файл v1/tariff/get.php
Функция ordoo_sdk_tariff_get()
POST/v1/tariff/purchase.php

Создание заказа

Идемпотентно создает pending-заказ с количеством и серверной суммой. card возвращает HTTPS checkout активного эквайринга в JSON; invoice доступен пользователю и организации и создает печатный счёт. Активный безлимит блокирует разовые и лимитные покупки, но новый безлимит продлевает текущий срок. При 050034 errors[] указывает конкретное поле.

tariff_id — публичный ID тарифа
organization_id — необязательный публичный ID организации; отсутствие означает личный заказ
payment_method — card или invoice для личного и организационного владельца
quantity — целое число 1–10000; для безлимитного тарифа только 1
idempotency_key — уникальная строка 16–191 символ
Авторизация Authorization: Bearer
Успех 050023
Ошибки 050034, 050035, 050036, 050037, 050038, 050039, 050042, 050043, 050051, 050052, 050057
SDK-файл v1/tariff/purchase.php
Функция ordoo_sdk_tariff_purchase()
GET/v1/billing/overview.php

Лицевой счет

Возвращает доступные регистрации над каталогом, дату окончания безлимита, owner-scoped заказы YY-NNNNNNNN, акты организации, чеки и ledger.

organization_id — необязательный публичный ID организации
Авторизация Authorization: Bearer
Успех 050024
Ошибки 050034, 050035, 050036, 050038, 050039
SDK-файл v1/billing/overview.php
Функция ordoo_sdk_billing_overview()
GET/v1/billing/usageList.php

История списаний

Возвращает append-only события первого успешного перевода документов в registered.

organization_id — необязательный публичный ID организации
Авторизация Authorization: Bearer
Успех 050025
Ошибки 050034, 050035, 050036, 050038, 050039
SDK-файл v1/billing/usageList.php
Функция ordoo_sdk_billing_usage_list()
POST/v1/billing/invoiceDownload.php

Скачать счёт

Возвращает PDF из активного DOCX-макета и неизменяемых снимков заказа; до активации первого макета сохраняет совместимый печатный HTML.

order_id — технический публичный ID заказа
organization_id — необязательный публичный ID организации
Авторизация Authorization: Bearer; для организации organization.finance.view
Успех 050053
Ошибки 050034, 050035, 050036, 050038, 050039
SDK-файл v1/billing/invoiceDownload.php
Функция ordoo_sdk_billing_invoice_download()
POST/v1/billing/receiptDownload.php

Скачать чек

Возвращает checksum-проверенный PDF-чек только финансовому владельцу заказа после административной загрузки.

order_id — публичный ID заказа
organization_id — необязательный публичный ID организации
Авторизация Authorization: Bearer
Успех 050049
Ошибки 050034, 050036, 050047, 050038, 050039
SDK-файл v1/billing/receiptDownload.php
Функция ordoo_sdk_billing_receipt_download()
POST/v1/billing/actDownload.php

Скачать акт

Возвращает checksum-проверенный PDF-акт только участнику организации после административной загрузки документа за календарный период.

act_id — публичный ID акта
organization_id — публичный ID организации
Авторизация Authorization: Bearer + organization.finance.view
Успех 050062
Ошибки 050034, 050035, 050036, 050038, 050039
SDK-файл v1/billing/actDownload.php
Функция ordoo_sdk_billing_act_download()
GET/v1/organization/course/list.php

Курсы организации

Возвращает собственные карточки, варианты часов, период, продвижение, комментарий модератора и обезличенные суммы просмотров/переходов.

organization_id — публичный ID организации
Авторизация Authorization: Bearer + organization.courses.manage
Успех 060002
Ошибки 060008, 060012
SDK-файл v1/organization/course/list.php
Функция ordoo_sdk_organization_course_list()
POST/v1/organization/course/save.php

Сохранить курс

Создает либо меняет доступный черновик с безопасным HTML, вариантами часов, HTTPS-ссылкой и периодами.

organization_id — публичный ID организации
title — название
description_html — безопасный HTML
hour_variants — целые часы 1–10000
payment_url — необязательный HTTPS URL
Авторизация Authorization: Bearer + organization.courses.manage
Успех 060001
Ошибки 060006, 060007, 060008, 060012, 060013
SDK-файл v1/organization/course/save.php
Функция ordoo_sdk_organization_course_save()
POST/v1/organization/course/submit.php

Отправить курс

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

organization_id — публичный ID организации
id — публичный ID курса
Авторизация Authorization: Bearer + organization.courses.manage
Успех 060003
Ошибки 060006, 060007, 060008, 060012, 060013
SDK-файл v1/organization/course/submit.php
Функция ordoo_sdk_organization_course_submit()
POST/v1/organization/course/archive.php

Архивировать курс

Закрывает черновик или немедленно снимает опубликованный курс с каталога, сохраняя историю и audit.

organization_id — публичный ID организации
id — публичный ID курса
confirm — явное подтверждение true
Авторизация Authorization: Bearer + organization.courses.manage
Успех 060015
Ошибки 060006, 060007, 060008, 060012, 060013
SDK-файл v1/organization/course/archive.php
Функция ordoo_sdk_organization_course_archive()
GET/v1/course/catalog.php

Публичный каталог

Возвращает только опубликованные сейчас карточки подтвержденных организаций, сначала продвигаемые.

Авторизация Не требуется
Успех 060004
Ошибки 060008
SDK-файл v1/course/catalog.php
Функция ordoo_sdk_course_catalog()
POST/v1/course/event.php

Событие каталога

Пишет обезличенный просмотр или переход к оплате без cookie и персональных данных.

id — публичный ID курса
event — view или click
Авторизация Не требуется; application/json
Успех 060005
Ошибки 060006, 060007, 060008, 060009
SDK-файл v1/course/event.php
Функция ordoo_sdk_course_event()

Официальный PHP SDK

Публичный SDK не использует Composer, классы приложения или autoload. Структура handlers зеркально повторяет API: endpoint /v1/user/login.php имеет wrapper OrdooApiSDK/v1/user/login.php. Административные wrappers и maintenance-доступ в партнерскую поставку не входят.

<?php

declare(strict_types=1);

$config = [
    'api' => ['base_url' => 'https://api.ordoo.ru'],
];

require_once __DIR__ . '/OrdooApiSDK/v1/user/login.php';

$result = ordoo_sdk_auth_login($config, 'user@example.ru', 'your-password');
Важно: пароль, access token и refresh token нельзя записывать в логи. SDK требует HTTPS и проверяет сертификат API.