Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов (версия 4.65.0) - часть 3

 

  Главная      Книги - Разные     Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов (версия 4.65.0)

 

поиск по сайту            правообладателям  

 

   

 

    

 

содержание      ..     1      2      3      4      ..

 

 

 

Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов (версия 4.65.0) - часть 3

 

 

необязателен.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document_id
Уникальный
String
UUID
1
идентификатор
документа
Пример использования метода
Запрос:
POST api/v1/documents/send HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"document":
"PGRvY3VtZW50cyB2ZXJzaW9uPSIxLjE2IiA+DQoJPHF1ZXJ5X2tpel9pbmZvIGFjdGlvbl9pZD0iMjEwIj4NC
gkJPHN1YmplY3RfaWQ+MDAwMDAwMDAwMDA1NjE8L3N1YmplY3RfaWQ+DQoJCTxzZ3Rpbj4xMTE3MDAxMjYxMDE
1MTAwMDAwMDAwYTAwMTE8L3NndGluPg0KCTwvcXVlcnlfa2l6X2luZm8+DQo8L2RvY3VtZW50cz4=",
"sign":
"UEdSdlkzVnRaVzUwY3lCMlpYSnphVzl1UFNJeExqRTJJaUErRFFvSlBIRjFaWEo1WDJ0cGVsOXBibVp2SUdGa
mRHbHZibDlwWkQwaU1qRXdJajROQ2drSlBITjFZbXBsWTNSZmFXUStNREF3TURBd01EQXdNREExTmpFOEwzTjF
ZbXBsWTNSZmFXUStEUW9KQ1R4elozUnBiajR4TVRFM01EQXhNall4TURFMU1UQXdNREF3TURBd1lUQXdNVEU4T
DNObmRHbHVQZzBLQ1R3dmNYVmxjbmxmYTJsNlgybHVabTgrRFFvOEwyUnZZM1Z0Wlc1MGN6ND0=",
"request_id": "fa257672-a902-4dbd-499f-15aed1c105c7",
"bulk_processing": false
}
Получение результата:
{
"document_id": "cc7890a8-39ac-4ba9-ae9a-b20f406a781c"
}
Документ должен подписываться зарегистрированным для пользователя сертификатом
(ключом).
100
5.2. Отправка документа большого объема
Endpoint: POST <endpoint>/<version>/documents/send_large
Необходимые права доступа: UPLOAD_DOCUMENT
Максимальный размер загружаемого файла - 15 Мб. Интервал между вызовами метода см. в
разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sign
Открепленная
String
BASE64
1*
См. Формат
подпись
электронной
документа
цифровой
подписи
hash_sum
Хэш сумма
String
1
Хэш сумма
документа
документа,
вычисленная
по алгоритму
SHA-256
request_id
Уникальный
String
UUID
1
Случайно
идентификатор
сгенерированн
запроса
ое значение,
удовлетворяю
щее формату
UUID
в
соответствии с
форматом из
Идентификато
р request_id
bulk_processin
Параметр,
Boolean
0
По умолчанию
g
регулирующий
false
способ
загрузки
документа
(группой или
нет)
* - Обязателен в случае, если участник - резидент, для участника-нерезидента реквизит
необязателен.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
101
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
link
Ссылка на
String
URL
1
Срок жизни
WebDAV для
ссылки на
загрузки
WebDAV
документа
составляет 2
часа. По
прошествии
этого времени
необходимо
повторно
вызвать метод,
чтобы
получить
новую ссылку,
если
необходимо
document_id
Id документа
String
UUID
1
Пример использования метода
Запрос:
POST api/v1/documents/send_large HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"sign":
"UEdSdlkzVnRaVzUwY3lCMlpYSnphVzl1UFNJeExqRTJJaUErRFFvSlBIRjFaWEo1WDJ0cGVsOXBibVp2SUdGa
mRHbHZibDlwWkQwaU1qRXdJajROQ2drSlBITjFZbXBsWTNSZmFXUStNREF3TURBd01EQXdNREExTmpFOEwzTjF
ZbXBsWTNSZmFXUStEUW9KQ1R4elozUnBiajR4TVRFM01EQXhNall4TURFMU1UQXdNREF3TURBd1lUQXdNVEU4T
DNObmRHbHVQZzBLQ1R3dmNYVmxjbmxmYTJsNlgybHVabTgrRFFvOEwyUnZZM1Z0Wlc1MGN6ND0=",
"hash_sum": "7a3a0686c6561e039c1319ac0c2337f808ac5e8870ef7b02296043fdce1aa254",
"request_id": "4f44aec6-aab4-4198-b567-7555f5129e9f",
"bulk_processing": false
}
Получение результата:
{
"document_id": "434bc499-4b85-4775-8c19-bf6dbf730e93",
"link": "http://api.sb.mdlp.crpt.ru:80/webdav/upload/434bc499-4b85-4775-8c19-
bf6dbf730e93/434bc499-4b85-4775-8c19-bf6dbf730e93"
102
}
Документ должен подписываться зарегистрированным для пользователя сертификатом
(ключом).
5.3. Загрузка документа большого объема
Endpoint: PUT <endpoint>/webdav/upload/{doc_id}/{doc_id}
Необходимые права доступа: UPLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Для загрузки на WebDAV больших документов необходимо использовать не просто HTTP
клиент, а WebDAV клиент. Он позволяет загружать большие документы целиком или по частям,
в отличие от обычного HTTP клиента.
Срок жизни ссылки на WebDAV составляет 2 часа. По прошествии этого времени необходимо
повторно вызвать метод "Отправка документа большого объема", чтобы получить новую ссылку,
если необходимо.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
doc_id
Уникальный
String
UUID
1
Параметр пути
идентификатор
(path param)
документа
В теле запроса передаётся загружаемый документ в формате XML.
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
PUT webdav/upload/434bc499-4b85-4775-8c19-bf6dbf730e93/434bc499-4b85-4775-8c19-
bf6dbf730e93 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/xml
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
<?xml version="1.0" encoding="UTF-8"?>
103
<documents xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
version="1.19">
<receive_order action_id="416">
<subject_id>00000000000000</subject_id>
<shipper_id>00000000000000</shipper_id>
<operation_date>2017-10-26T15:02:00+05:00</operation_date>
<doc_num>dok 1</doc_num>
<doc_date>27.10.2017</doc_date>
<receive_type>1</receive_type>
<contract_type>1</contract_type>
<order_details>
<union>
<sgtin>00000000000000000000000000</sgtin>
<cost>1.0</cost>
</union>
</order_details>
</receive_order>
</documents>
Получение результата:
HTTP код 201 Created
5.4. Завершение отправки документа
Endpoint: POST <endpoint>/<version>/documents/send_finished
Необходимые права доступа: UPLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document_id
Id документа
String
UUID
1
Выходная информация
По результатам выполнения клиент получает следующую информацию:
104
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
request_id
Уникальный
String
UUID
1
идентификатор
запроса
Пример использования метода
Запрос:
POST api/v1/documents/send_finished HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"document_id": "434bc499-4b85-4775-8c19-bf6dbf730e93"
}
Получение результата:
{
"request_id": "4f44aec6-aab4-4198-b567-7555f5129e9f"
}
5.5. Запуск обработки группы документов
Endpoint: POST <endpoint>/<version>/documents/bulk
Необходимые права доступа: BULK_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
105
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document_ids
Идентификато
Array of Strings
UUID
1
Обработка
ры документов
документов
будет
осуществлена
последователь
но в том
порядке, в
котором
заполнен
параметр
document_ids.
Максимальное
количество
значений
параметра в
запросе - 300
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
bulk_id
Id группы
String
UUID
1
документов
Пример использования метода
Запрос:
POST api/v1/documents/bulk HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"document_ids": ["4f44aec6-aab4-4198-b567-7555f5129e9a", "4f44aec6-aab4-4198-b567-
7555f5129e9b"]
}
Получение результата:
106
{
"bulk_id": "4f44aec6-aab4-4198-b567-7555f5129e9c"
}
5.6. Проверка возможности запуска группы документов
Endpoint: POST /api/v1/documents/bulk/check
Необходимые права доступа: BULK_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document_ids
Идентификато
Array of Strings
UUID
1
ры документов
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
documents
Массив
Array of
DocumentBulk
1
результатов по
Objects
CheckResultIte
запрошенным
m
документам
Структура данных DocumentBulkCheckResultItem:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document_id
Идентификато
String
UUID
1
р документа
107
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
ready_for_bulk
Флаг,
Boolean
1
отражающий
готовность
документа к
загрузке
группой
error_code
Код ошибки,
String
0
не заполняется
возникшей при
для
проверке
ready_for_bulk,
документа
равному false
error_descriptio
Текст
String
0
не заполняется
n
сообщения
для
возникшей
ready_for_bulk,
ошибки
равному false
Пример использования метода
Запрос:
POST api/v1/documents/bulk/check HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"document_ids": ["4f44aec6-aab4-4198-b567-7555f5129e9a", "4f44aec6-aab4-4198-b567-
7555f5129e9b"]
}
Получение результата:
{
"documents": [
{
"document_id": "4f44aec6-aab4-4198-b567-7555f5129e9a",
"ready_for_bulk": true
},
{
"document_id": "4f44aec6-aab4-4198-b567-7555f5129e9b",
"ready_for_bulk": false,
"error_code": "document.bulk.not_found",
"error_description": "Загрузка невозможна. Документ 4f44aec6-aab4-4198-b567-
7555f5129e9b не найден"
108
}
]
}
5.7. Получение информации о группе документов
Endpoint: GET /api/v1/documents/bulk/{bulk_id}
Необходимые права доступа: UPLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
bulk_id
Идентификато
String
UUID
1
р группы
документов
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
bulk_id
Идентификато
String
UUID
1
р группы
документов
109
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
bulk_status
Статус группы
String
1
возможные
документов
статусы:
IN_PROGRES
S - группы
документов
находится в
процессе
обработки.
Возможен
переход в
статусы
ERROR или
DONE;
ERROR -
произошла
ошибка при
обработке
группы
документов.
Статус
конечный,
переход в
другой статус
невозможен;
DONE -
обработка
группы
документов
завершилась
успешно.
Статус
конечный,
переход в
другой статус
невозможен.
create_date
Дата и время
String
MskDateTime
1
создания
группы
document_ids
Массив
Array of Strings
UUID
1
идентификато
ров
документов,
относящихся к
группе
Пример использования метода
110
Запрос:
GET api/v1/documents/bulk/6480c50f-f79e-49cd-8b2f-45de23bb0185 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"bulk_id": "6480c50f-f79e-49cd-8b2f-45de23bb0185",
"bulk_status": "IN_PROGRESS",
"create_date": "2017-11-23 05:48:15",
"document_ids": [
"5f44aec6-aab4-4198-b567-7555f5129e9f",
"6f44aec6-aab4-4198-b567-7555f5129e9f"
]
}
5.8. Получение информации по имеющимся группам
документов
Endpoint: POST /api/v1/documents/bulk/filter
Необходимые права доступа: UPLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
1
записи в
списке
возвращаемых
групп
count
Количество
Number
1
записей в
списке
возвращаемых
групп
111
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр групп
Object
BulkFilter
1
документов
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
bulks
Список групп
Array of
BulkFilterResp
1
Группы
документов
Objects
onseItem
отсортированы
по убыванию
даты создания
Пример использования метода
Запрос:
POST api/v1/documents/bulk/filter HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {
"bulk_ids": ["4f44aec6-aab4-4198-b567-7555f5129e9f","4f44aec6-aab4-4198-b567-
7555f5129e9f"],
"create_date_from": "2017-11-23 05:48:15",
"create_date_to": "2017-11-23 05:48:15"
},
"start_from": 0,
"count": 100
}
Получение результата:
{
112
"total": 2,
"bulks": [
{
"bulk_id": "4f44aec6-aab4-4198-b567-7555f5129e9f",
"bulk_status": "IN_PROGRESS",
"create_date": "2017-11-23 05:48:15"
},
{
"bulk_id": "000aec6-aab4-4198-b567-7555f512900f",
"bulk_status": "DONE",
"create_date": "2017-11-23 05:48:15"
}
]
}
5.9. Получение информации об ограничении размера
небольших документов
Возвращает максимальный размер документа в байтах, который может быть отправлен без
WebDAV.
Endpoint: GET <endpoint>/<version>/documents/doc_size
Необходимые права доступа: не требуются
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Никакой входной информации предоставлять не требуется
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
doc_size
Максимальны
Number
1
й размер
документа в
байтах
Пример использования метода
Запрос:
GET api/v1/documents/doc_size HTTP/1.1
Host: api.sb.mdlp.crpt.ru
113
Accept: application/json
Получение результата:
{
"doc_size": 1048576
}
5.10. Отмена отправки документа
Endpoint: POST <endpoint>/<version>/documents/cancel
Необходимые права доступа: UPLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document_id
Идентификато
String
UUID
1
р документа
request_id
Уникальный
String
UUID
1
идентификатор
запроса
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
POST api/v1/documents/cancel HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"document_id": "434bc499-4b85-4775-8c19-bf6dbf730e93",
"request_id": "4f44aec6-aab4-4198-b567-7555f5129e9f"
114
}
5.11. Получение списка исходящих документов
Endpoint: POST <endpoint>/<version>/documents/outcome
Необходимые права доступа: OUTCOME_LIST
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры получения
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр списка
Object
DocOutcomeFil
1
См. Формат
документов
ter
объекта
DocOutcomeFil
ter
start_from
Индекс первой
Number
1
записи в
списке
возвращаемых
документов
count
Количество
Number
1
записей в
списке
возвращаемых
документов
Выходная информация
Результат запроса - исходящие документы не старше 30 суток, отсортированные по дате.
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
documents
Список
Array of
OutcomeDocu
1
документов
Objects
ment
total
Общее
Number
1
количество
записей по
запросу
115
Пример использования метода
Запрос:
POST api/v1/documents/outcome HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {
"doc_status": "PROCESSED_DOCUMENT",
"skzkm_report_id": "434bc499-4b85-4775-8c19-bf6dbf730e91"
},
"start_from": 0,
"count": 100
}
Получение результата:
{
"documents": [
{
"request_id": "996f487c-d902-4dbd-b99f-76aef2d904dc",
"document_id": "6e491238-d4a9-495b-8d37-45181916c846",
"date": "2020-12-01 05:48:15",
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "0c290e4a-aabb-40ae-8ef2-ce462561ce7f",
"doc_type": 0,
"doc_status": "PROCESSED_DOCUMENT",
"processing_document_status": "REJECTED",
"version": "1.28",
"skzkm_report_id": "434bc499-4b85-4775-8c19-bf6dbf730e91"
},
{
"request_id": "fa257672-a902-4dbd-499f-15aed1c105c7",
"document_id": "cc7890a8-39ac-4ba9-ae9a-b20f406a781c",
"date": "2020-12-07 10:12:56",
"sender": "00000000000561",
"sys_id": "0c290e4a-aabb-40ae-8ef2-ce462561ce7f",
"doc_type": 210,
"doc_status": "PROCESSED_DOCUMENT",
"processing_document_status": "ACCEPTED",
"skzkm_report_id": "434bc499-4b85-4775-8c19-bf6dbf730e91"
},
{
"request_id": "ac91de6e-f6ae-49e6-8a6d-c4ea008480d4",
"document_id": "1683a4c0-9d2c-4da7-b63b-3784b80a6f62",
"date": "2020-12-12 11:00:20",
116
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "0c290e4a-aabb-40ae-8ef2-ce462561ce7f",
"doc_type": 10311,
"doc_status": "PROCESSED_DOCUMENT",
"processing_document_status": "PARTIAL",
"device_id": "1230000011111111",
"skzkm_origin_msg_id": "e2cb20c1-1d5b-4ab6-b8dd-9297bec23f63",
"skzkm_report_id": "434bc499-4b85-4775-8c19-bf6dbf730e91"
}
],
"total": 3
}
5.12. Получение списка исходящих документов из витрины
документов
Endpoint: POST <endpoint>/<version>/documents/showcase/outcome
Необходимые права доступа: OUTCOME_LIST
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры получения
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр списка
Object
DocOutcomeSh
1
См. Формат
документов
owcaseFilter
объекта
DocOutcomeSh
owcaseFilter
count
Количество
Number
1
записей в
списке
возвращаемых
документов
next_page_key
Параметр
Array of any
0
Заполняется из
пагинации
type
ответа на
предыдущий
запрос при
запросе
следующих
данных
Выходная информация
Результат запроса - все исходящие документы, отсортированные по дате.
117
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
documents
Список
Array of
OutcomeDocu
1
документов*
Objects
ment
total
Общее
Number
1
количество
записей по
запросу
next_page_key
Параметр
Array of any
0
Содержит
пагинации
type
характеристик
и для
следующей
страницы
запроса
Массив next_page_key может содержать произвольное количество элементов. В примере
приведен возможный состав массива.
Пример использования метода
Запрос:
POST api/v1/documents/documents/showcase/outcome HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {
"doc_status": "PROCESSED_DOCUMENT"
},
"count": 3
}
Получение результата:
{
"documents": [
{
"request_id": "996f487c-d902-4dbd-b99f-76aef2d904dc",
"document_id": "6e491238-d4a9-495b-8d37-45181916c846",
"date": "2017-11-23 05:48:15",
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "0c290e4a-aabb-40ae-8ef2-ce462561ce7f",
118
"doc_type": 0,
"doc_status": "PROCESSED_DOCUMENT",
"processing_document_status": "REJECTED",
"version": "1.28",
"skzkm_report_id": "434bc499-4b85-4775-8c19-bf6dbf730e91"
},
{
"request_id": "fa257672-a902-4dbd-499f-15aed1c105c7",
"document_id": "cc7890a8-39ac-4ba9-ae9a-b20f406a781c",
"date": "2017-12-01 10:12:56",
"sender": "00000000000561",
"sys_id": "0c290e4a-aabb-40ae-8ef2-ce462561ce7f",
"doc_type": 210,
"doc_status": "PROCESSED_DOCUMENT",
"processing_document_status": "ACCEPTED",
"skzkm_report_id": "434bc499-4b85-4775-8c19-bf6dbf730e91"
},
{
"request_id": "ac91de6e-f6ae-49e6-8a6d-c4ea008480d4",
"document_id": "1683a4c0-9d2c-4da7-b63b-3784b80a6f62",
"date": "2018-12-30 11:00:20",
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "0c290e4a-aabb-40ae-8ef2-ce462561ce7f",
"doc_type": 10311,
"doc_status": "PROCESSED_DOCUMENT",
"processing_document_status": "PARTIAL",
"device_id": "1230000011111111",
"skzkm_origin_msg_id": "e2cb20c1-1d5b-4ab6-b8dd-9297bec23f63",
"skzkm_report_id": "434bc499-4b85-4775-8c19-bf6dbf730e91"
}
],
"total": 100,
"next_page_key": [
1596629736232,
"1683a4c0-9d2c-4da7-b63b-3784b80a6f62"
]
}
5.13. Получение списка входящих документов
Endpoint: POST <endpoint>/<version>/documents/income
Необходимые права доступа: INCOME_LIST
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры получения
Входной информацией являются следующие данные:
119
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр списка
Object
DocIncomeFilte
1
документов
r
start_from
Индекс первой
Number
1
записи в
списке
возвращаемых
документов
count
Количество
Number
1
записей в
списке
возвращаемых
документов
Выходная информация
Результат запроса - входящие документы не старше 30 суток, отсортированные по дате (за
исключением документов по схеме 200).
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
documents
Список
Array of
IncomeDocume
1
документов
Objects
nt
total
Общее
Number
1
количество
записей по
запросу
Пример использования метода
Запрос:
POST api/v1/documents/income HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {},
"start_from": 0,
"count": 10
120
}
Получение результата:
{
"documents": [
{
"request_id": "dc6b4629-7400-437a-92e3-8f92a950adc4",
"document_id": "08ceee27-46d7-40ae-93df-1befcb74fbac",
"date": "2020-12-10 05:48:15",
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "7a9eb56a-6d44-41b5-8a97-fc91bf9f89fa",
"doc_type": 607,
"doc_status": "PROCESSED_DOCUMENT",
"file_uploadtype": 1,
"sender_sys_id": "a1281468-f4ae-4a61-b439-d63febcf77e4",
"version": "1.28"
},
{
"request_id": "ead5dc44-0999-4352-aabb-13ad505b8fcb",
"document_id": "a208c35f-96f4-46f1-be3e-7d3af31c5fa6",
"date": "2020-12-09 10:12:56",
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "0c290e4a-aabb-40ae-8ef2-ce462561ce7f",
"doc_type": 609,
"doc_status": "PROCESSED_DOCUMENT",
"file_uploadtype": 1,
"sender_sys_id": "a1281468-f4ae-4a61-b439-d63febcf77e4"
}
],
"total": 2
}
5.14. Получение списка входящих документов из витрины
документов
Endpoint: POST <endpoint>/<version>/documents/showcase/income
Необходимые права доступа: INCOME_LIST
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры получения
Входной информацией являются следующие данные:
121
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр списка
Object
DocIncomeSho
1
См. Формат
документов
wcaseFilter
объекта
DocIncomeSho
wcaseFilter
count
Количество
Number
1
записей в
списке
возвращаемых
документов
next_page_key
Параметр
Array of any
0
Заполняется из
пагинации
type
ответа на
предыдущий
запрос при
запросе
следующих
данных
Ограничения
В данном методе действует ограничение на поле doc_num из объекта DocIncomeShowcaseFilter: 3
или более символов
Выходная информация
Результат запроса - входящие документы, отсортированные по дате (за исключением документов
по схеме 200).
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
documents
Список
Array of
IncomeDocume
1
документов
Objects
nt
total
Общее
Number
1
количество
записей по
запросу
next_page_key
Параметр
Array of any
0
Содержит
пагинации
type
характеристик
и для
следующей
страницы
запроса
122
Массив next_page_key может содержать произвольное количество элементов. В примере
приведен возможный состав массива.
Пример использования метода
Запрос:
POST api/v1/documents/showcase/income HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {},
"count": 2
}
Получение результата:
{
"documents": [
{
"request_id": "dc6b4629-7400-437a-92e3-8f92a950adc4",
"document_id": "08ceee27-46d7-40ae-93df-1befcb74fbac",
"date": "2017-11-10 05:48:15",
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "7a9eb56a-6d44-41b5-8a97-fc91bf9f89fa",
"doc_type": 607,
"doc_status": "PROCESSED_DOCUMENT",
"file_uploadtype": 1,
"sender_sys_id": "a1281468-f4ae-4a61-b439-d63febcf77e4",
"version": "1.28"
},
{
"request_id": "ead5dc44-0999-4352-aabb-13ad505b8fcb",
"document_id": "a208c35f-96f4-46f1-be3e-7d3af31c5fa6",
"date": "2017-11-09 10:12:56",
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "0c290e4a-aabb-40ae-8ef2-ce462561ce7f",
"doc_type": 609,
"doc_status": "PROCESSED_DOCUMENT",
"file_uploadtype": 1,
"sender_sys_id": "a1281468-f4ae-4a61-b439-d63febcf77e4"
}
],
"total": 100,
"next_page_key": [
1596629736232,
"a208c35f-96f4-46f1-be3e-7d3af31c5fa6"
123
]
}
5.15. Передача информации о прочтении документа
Endpoint: POST <endpoint>/<version>/documents/income/mark_read
Необходимые права доступа: INCOME_LIST
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры передачи
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document_ids
Массив
Array of Strings
UUID
1
Максимальное
идентификато
возможное
ров
количество
документов,
документов
для которых
100
необходимо
проставить
статус
"прочитано"
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
marked_docum
Массив
Array of Strings
UUID
0
ent_ids
идентификато
ров
документов,
которым
проставлен
статус
"прочитано"
124
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Количество
Number
0
документов,
для которых
проставлен
статус
"прочитано"
Пример использования метода
Запрос:
POST api/v1/documents/income/mark_read HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"document_ids":[
"8033d6aa-1ccd-4e76-9e86-c10c522f6201",
"8033d6aa-1ccd-4e76-9e86-c10c522f6271",
"8033d6aa-1ccd-4e76-9e86-c10c522f6801"
]
}
Получение результата:
HTTPStatus: 200 OK
{
"marked_document_ids": [
"8033d6aa-1ccd-4e76-9e86-c10c522f6201",
"8033d6aa-1ccd-4e76-9e86-c10c522f6271",
"8033d6aa-1ccd-4e76-9e86-c10c522f6801"
],
"total": 3
}
5.16. Получение метаданных документа
Endpoint: GET <endpoint>/<version>/documents/{docId}
Необходимые права доступа: DOWNLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
125
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
doc_id
Уникальный
String
UUID
1
Параметр пути
идентификатор
(path param)
документа
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document
Документ,
Object
OutcomeDocu
1
соответствую
ment либо
щий данному
IncomeDocume
id
nt в
зависимости
от типа
документа
Пример использования метода
Запрос:
GET api/v1/documents/b88bcb04-45fd-4204-91c8-446cc7f31a38 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"request_id": "3f4d586c-d901-4dbd-b99f-73aed1d903ca",
"document_id": "b88bcb04-45fd-4204-91c8-446cc7f31a38",
"date": "2017-11-01",
"sender": "935ba7bc-b022-11e7-abc4-cec278b6b50a",
"sys_id": "7a9eb56a-6d44-41b5-8a97-fc91bf9f89fa",
"doc_type": 0,
"doc_status": "UPLOADING_DOCUMENT",
"device_id": "1230000011111111",
"skzkm_origin_msg_id": "e2cb20c1-1d5b-4ab6-b8dd-9297bec23f63",
126
"version": "1.28"
}
5.17. Получение документа по идентификатору
Endpoint: GET <endpoint>/<version>/documents/download/{docId}
Необходимые права доступа: DOWNLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
doc_id
Уникальный
String
UUID
1
Параметр пути
идентификатор
(path param)
документа
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
link
Ссылка на
String
URL
1
Срок жизни
WebDAV для
ссылки на
скачивания
WebDAV
документа
составляет 2
часа. По
прошествии
этого времени
необходимо
повторно
вызвать метод,
чтобы
получить
новую ссылку,
если
необходимо
Пример использования метода
Запрос:
127
GET api/v1/documents/download/75012095-7f56-4653-8aa1-dfa40ee19b7a HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"link": "http://api.sb.mdlp.crpt.ru/webdav/upload/75012095-7f56-4653-8aa1-
dfa40ee19b7a/75012095-7f56-4653-8aa1-dfa40ee19b7a"
}
5.18. Получение списка документов по идентификатору
запроса
Endpoint: GET <endpoint>/<version>/documents/request/{request_id}
Необходимые права доступа: DOWNLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
request_id
Уникальный
String
UUID
1
Параметр пути
идентификатор
(path param)
запроса
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
documents
Список
Array of
OutcomeDocu
1
документов
Objects
ment либо
IncomeDocume
nt в
зависимости
от типа
документа
128
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
Пример использования метода
Запрос:
GET api/v1/documents/request/ca738a54-37be-4e28-9c39-a55cac2611b1 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"documents": [
{
"request_id": "ca738a54-37be-4e28-9c39-a55cac2611b1",
"document_id": "2c96e354-7c5c-440d-b750-79c35d761465",
"date": "2017-12-01",
"sender": "00000000000374",
"sys_id": "6be50ba4-c20c-4b90-90a4-c6edbb97fe06",
"doc_type": 415,
"doc_status": "PROCESSED_DOCUMENT"
},
{
"request_id": "ca738a54-37be-4e28-9c39-a55cac2611b1",
"document_id": "75012095-7f56-4653-8aa1-dfa40ee19b7a",
"date": "2017-12-01",
"sender": "00000000000374",
"sys_id": "6be50ba4-c20c-4b90-90a4-c6edbb97fe06",
"doc_type": 200,
"doc_status": "PROCESSED_DOCUMENT",
"sender_sys_id": "6be50ba4-c20c-4b90-90a4-c6edbb97fe06"
}
],
"total": 2
}
5.19. Получение квитанции по номеру исходящего документа
Endpoint: GET <endpoint>/<version>/documents/{docId}/ticket
129
Необходимые права доступа: DOWNLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
docId
Номер
String
UUID
1
Параметр пути
исходящего
(path param)
документа
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
link
Ссылка на
String
URL
1
Срок жизни
документ-
ссылки на
квитанцию
WebDAV
составляет 2
часа. По
прошествии
этого времени
необходимо
повторно
вызвать метод,
чтобы
получить
новую ссылку,
если
необходимо
Пример использования метода
Запрос:
GET api/v1/documents/97877d07-c949-4e98-9c26-49d9cb4d9fbd/ticket HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
130
{
"link": "http://api.sb.mdlp.crpt.ru:80/webdav/upload/97877d07-c949-4e98-9c26-
49d9cb4d9fbd/ticket_97877d07-c949-4e98-9c26-49d9cb4d9fbd"
}
5.20. Получение электронной подписи исходящего документа
Endpoint: GET <endpoint>/<version>/documents/{docId}/signature
Необходимые права доступа: DOWNLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
docId
Номер
String
UUID
1
Параметр пути
исходящего
(path param)
документа
Выходная информация
По результатам выполнения клиент получает следующую информацию:
В теле запросе строка в формате BASE64, кодирующая открепленную подпись документа в
формате CMS.
Пример использования метода
Запрос:
GET api/v1/documents/64037f8a-c816-4555-88ab-a00f74f7b222/signature HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: text/plain
Authorization: token c59a91ad-9452-4041-b625-1395b513ec61
Получение результата:
MIIJzQYJKoZIhvcNAQcCoIIJvjCCCboCAQExDDAKBgYqhQMCAgkFADALBgkqhkiG9w0BBwGgggdk
MIIHYDCCBw+gAwIBAgIQDZk4XRUAzoDnEXRwQRuZBDAIBgYqhQMCAgMwXzEWMBQGBSqFA2QDEgsw
MDAwMDAwMDAwMDEYMBYGBSqFA2QBEg0wMDAwMDAwMDAwMDAwMRowGAYIKoUDA4EDAQESDDAwMDAw
MDAwMDAwMDEPMA0GA1UEAwwGQ0FURVNUMB4XDTE3MDcyNDEzMTg0NloXDTE4MDcyNDEzMjg0Nlow
ggJXMRYwFAYFKoUDZAMSCzExMjIzMzQ0NTk1MRgwFgYFKoUDZAESDTExNDkyMDQwMDc3NTQxGjAY
BggqhQMDgQMBARIMMDA5MjAzMDAxMTY1MR0wGwYJKoZIhvcNAQkBFg5lbWFpbEBlbWFpbC5ydTEL
131
MAkGA1UEBhMCUlUxHDAaBgNVBAgMEzc3INCzLiDQnNC+0YHQutCy0LAxGDAWBgNVBAcMD9CzLtCc
0L7RgdC60LLQsDE4MDYGA1UECgwvItCe0J7QniAiItCi0JXQn9Cb0J7Qn9Cg0JjQkdCe0KDQodCV
0KDQktCY0KEiIiIxODA2BgNVBAsMLyLQntCe0J4gIiLQotCV0J/Qm9Ce0J/QoNCY0JHQntCg0KHQ
ldCg0JLQmNChIiIiMTgwNgYDVQQDDC8i0J7QntCeICIi0KLQldCf0JvQntCf0KDQmNCR0J7QoNCh
0JXQoNCS0JjQoSIiIjE4MDYGA1UECQwv0LMuINCc0L7RgdC60LLQsCwg0JDQtNGA0LXRgdC+0LIg
0L/QtdGALiwg0LQuIDgxPjA8BgkqhkiG9w0BCQIML0lOTj05MjAzMDAxMTY1L0tQUD05MjAzMDEw
MDEvT0dSTj0xMTQ5MjA0MDA3NzU0MTAwLgYDVQQMDCfQk9C10L3QtdGA0LDQu9GM0L3Ri9C5INC0
0LjRgNC10LrRgtC+0YAxMjAwBgNVBCoMKdCQ0LvRjNCx0LXRgNGCINCQ0LvQtdC60YHQsNC90LTR
gNC+0LLQuNGHMRUwEwYDVQQEDAzQntGB0LjQv9C+0LIwYzAcBgYqhQMCAhMwEgYHKoUDAgIkAAYH
KoUDAgIeAQNDAARADyNXAfrKPa1r0x2y/83/tSQ9muynQy4/KXjbU15ca+zCcvTzEEcHeGONR1PD
gDQQW/H3XKw2OHA+GfB2MK5c5qOCA6kwggOlMA4GA1UdDwEB/wQEAwIE8DBfBgNVHSUEWDBWBggr
BgEFBQcDAgYIKwYBBQUHAwQGByqFAwICIgYGCCqFAwYtAQEBBggqhQMGLAEBAQYGKoUDBigBBggq
hQMGKQEBAQYIKoUDBioFBQUGByqFAwMGAAwwNgYFKoUDZG8ELQwrItCa0YDQuNC/0YLQvtCf0YDQ
viBDU1AiICjQstC10YDRgdC40Y8gMy45KTAeBgkrBgEEAYI3FQcEETAPBgcqhQMDBgMMAgEBAgEA
MIGYBgNVHSMEgZAwgY2AFJpOAYvF7EuL8c/3wOzLOlulz9keoWOkYTBfMRYwFAYFKoUDZAMSCzAw
MDAwMDAwMDAwMRgwFgYFKoUDZAESDTAwMDAwMDAwMDAwMDAxGjAYBggqhQMDgQMBARIMMDAwMDAw
MDAwMDAwMQ8wDQYDVQQDDAZDQVRFU1SCEA2ZOF0VALyA5hEq9HUtSRYwHQYDVR0OBBYEFG5+Q/nw
WFCp5uX4ZHogKQtrEWCHMB0GA1UdIAQWMBQwCAYGKoUDZHEBMAgGBiqFA2RxAjArBgNVHRAEJDAi
gA8yMDE3MDcyNDEzMTg0NlqBDzIwMTgwNzI0MTMxODQ2WjCCAW8GBSqFA2RwBIIBZDCCAWAMKyLQ
mtGA0LjQv9GC0L7Qn9GA0L4gQ1NQIiAo0LLQtdGA0YHQuNGPIDMuOSkMgY7Qn9GA0L7Qs9GA0LDQ
vNC80L3Qvi3QsNC/0L/QsNGA0LDRgtC90YvQuSDQutC+0LzQv9C70LXQutGBICLQo9C00L7RgdGC
0L7QstC10YDRj9GO0YnQuNC5INGG0LXQvdGC0YAgItCa0YDQuNC/0YLQvtCf0YDQviDQo9CmIiDQ
stC10YDRgdC40LggMi4wDE/QodC10YDRgtC40YTQuNC60LDRgiDRgdC+0L7RgtCy0LXRgtGB0YLQ
stC40Y8g4oSWINCh0KQvMTI0LTI1Mzkg0L7RgiAxNS4wMS4yMDE1DE/QodC10YDRgtC40YTQuNC6
0LDRgiDRgdC+0L7RgtCy0LXRgtGB0YLQstC40Y8g4oSWINCh0KQvMTI0LTI4ODEg0L7RgiAxMi4w
NC4yMDE2MCoGA1UdHwQjMCEwH6AdoBuGGWh0dHA6Ly9jaTc3LnJ1L2NhdGVzdC5jcmwwNQYIKwYB
BQUHAQEEKTAnMCUGCCsGAQUFBzAChhlodHRwOi8vY2k3Ny5ydS9jYXRlc3QuY2VyMAgGBiqFAwIC
AwNBAFJRWyTep87dMOYQCb4qHd6m6AHEg6cDfB9LyACwya5RxhEQM0z4qvs3yadA9M00AhuNphxk
ZL6nG4MZJSoflf4xggIwMIICLAIBATBzMF8xFjAUBgUqhQNkAxILMDAwMDAwMDAwMDAxGDAWBgUq
hQNkARINMDAwMDAwMDAwMDAwMDEaMBgGCCqFAwOBAwEBEgwwMDAwMDAwMDAwMDAxDzANBgNVBAMM
BkNBVEVTVAIQDZk4XRUAzoDnEXRwQRuZBDAKBgYqhQMCAgkFAKCCAVYwGAYJKoZIhvcNAQkDMQsG
CSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMTgwNjE1MTA0MTUyWjAqBgorBgEEAYI3WAIBMRwE
GkQAbwBjAHUAbQBlAG4AdAAgAE4AYQBtAGUAMC8GCSqGSIb3DQEJBDEiBCC0miFAFUSYGMBXwGFM
I3rsJqkOG01Cj3NtQG4buBAjFjCBvgYLKoZIhvcNAQkQAi8xga4wgaswgagwgaUwCAYGKoUDAgIJ
BCD1gMACdEZ1WP0z99r3gfiE0X6fQnLnvyOWxKV/K9g5fzB3MGOkYTBfMRYwFAYFKoUDZAMSCzAw
MDAwMDAwMDAwMRgwFgYFKoUDZAESDTAwMDAwMDAwMDAwMDAxGjAYBggqhQMDgQMBARIMMDAwMDAw
MDAwMDAwMQ8wDQYDVQQDDAZDQVRFU1QCEA2ZOF0VAM6A5xF0cEEbmQQwCgYGKoUDAgITBQAEQCxA
hVx4wVA/CjE1Oki9xW3PBQwVgCi/YmmdHzdAt5/fFCMJoaUOjr+E9S4Xf7EDlgqsLNQwDBwYYSJ8
YrXJbU4=
5.21. Прослеживание документов по отчёту из СУЗ
Endpoint: POST <endpoint>/<version>/documents/skzkm-traces/filter
Необходимые права доступа: VIEW_SKZKM_REPORT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
132
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр списка
Object
SkzkmTraceFilt
1
документов
er
start_from
Индекс первой
Number
1
записи в
списке
возвращаемых
документов
count
Количество
Number
1
записей в
списке
возвращаемых
документов
Структура данных SkzkmTraceFilter
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
skzkm_report_i
Идентификато
String
UUID
1
d
р отчета СУЗ
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
items
Список
Array of
MarkingDocum
1
документов*
Objects
ent
total
Общее
Number
1
количество
записей по
запросу
Структура данных MarkingDocument:
133
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
document_id
Идентификато
String
UUID
1
р документа
request_id
Уникальный
String
UUID
1
идентификатор
запроса
date
Дата и время
String
DateTime
1
получения
документа
doc_type
Тип документа
Number
ACTION_ID
1
Соответствует
номеру схемы
XSD
processing_doc
Статус
String
{PROCESSIN
1
•
PROCESSI
ument_status
обработки
G,
NG - В
документа
ACCEPTED,
процессе
PARTIAL,
обработки;
REJECTED,
•
ACCEPTE
TECH_ERROR
D - Обраб
}
отан;
•
PARTIAL
- Обработ
ан
частично;
•
REJECTED
- Отклон
ен;
•
TECH_ER
ROR - Те
хническая
ошибка;
processed_date
Дата и время
String
DateTime
0
обработки
документа
sgtin_count
Кол-во КиЗ в
Number
1
документе
* - Результаты отсортированы по атрибуту date.
Пример использования метода
Запрос:
POST /api/v1/documents/skzkm-traces/filter HTTP/1.1
134
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token c59a91ad-9452-4041-b625-1395b513ec61
{
"filter":{"skzkm_report_id": "434bc499-4b85-4775-8c19-bf6dbf730e93"},
"start_from": 0,
"count": 10
}
Получение результата:
{
"items":[
{
"document_id":"8033d6aa-1ccd-4e76-9e86-c10c522f6201",
"request_id": "ca738a54-37be-4e28-9c39-a55cac2611b1",
"date":"2018-11-16T13:22:06",
"doc_type":10311,
"processing_document_status":"ACCEPTED",
"processed_date":"2018-11-16T13:22:16",
"sgtin_count":2
},
{
"document_id":"d3d9e71c-fe73-45a0-9909-1f3d1e7d8829",
"request_id": "ca738a54-37be-4e28-9c39-a55cac2611b1",
"date":"2019-01-28T10:57:07",
"doc_type":10311,
"processing_document_status":"ACCEPTED",
"processed_date":"2019-01-28T10:58:05",
"sgtin_count":1
},
{
"document_id":"28fee8f4-9717-424a-8016-8835a1ffc0b5",
"request_id": "ca738a54-37be-4e28-9c39-a55cac2611b1",
"date":"2019-01-28T12:50:18",
"doc_type":10311,
"processing_document_status":"ACCEPTED",
"processed_date":"2019-01-28T12:50:37",
"sgtin_count":3
}
],
"total":3
}
5.22. Скачивание документа по идентификатору
Endpoint: GET <endpoint>/webdav/upload/{doc_id}/{doc_id}
135
Необходимые права доступа: UPLOAD_DOCUMENT или DOWNLOAD_DOCUMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Для скачивания больших документов необходимо использовать не просто HTTP клиент, а
WebDAV клиент. Он позволяет загружать и скачивать большие документы целиком или по
частям, в отличие от обычного HTTP клиента.
Метод позволяет скачать документ или квитанцию, предварительно получив на них ссылку с
помощью методов "Получение документа по идентификатору" или "Получение квитанции по
номеру исходящего документа". Срок жизни ссылки на WebDAV составляет 2 часа. По
прошествии этого времени необходимо повторить запрос на получение документа по
идентификатору, если необходимо.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
doc_id
Уникальный
String
UUID
1
Параметр пути
идентификатор
(path param)
документа
Выходная информация
По результатам выполнения клиент получает документ в формате XML.
Пример использования метода
Запрос:
GET api/v1/webdav/upload/434bc499-4b85-4775-8c19-bf6dbf730e93/434bc499-4b85-4775-8c19-
bf6dbf730e93 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
<?xml version="1.0" encoding="UTF-8"?>
<documents xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.38">
<receive_order action_id="416">
<subject_id>00000000000000</subject_id>
<shipper_id>00000000000000</shipper_id>
<operation_date>2017-10-26T15:02:00+05:00</operation_date>
<doc_num>dok 1</doc_num>
<doc_date>27.10.2017</doc_date>
<receive_type>1</receive_type>
136
<contract_type>1</contract_type>
<order_details>
<union>
<sgtin>00000000000000000000000000</sgtin>
<cost>1.0</cost>
</union>
</order_details>
</receive_order>
</documents>
137
6. Пользователи и учетные системы
6.1. Регистрация учетной системы и пользователей
6.1.1. Метод для регистрации учетной системы
Endpoint: POST <endpoint>/<version>/registration/accounting_system
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sys_id
Идентификато
String
SysID
1
р субъекта
обращения в
«ИС
"Маркировка".
МДЛП»
name
Название
String
1
учетной
системы
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
client_secret
Секретный
String
1
ключ
client_id
Идентификато
String
UUID
1
р клиента
account_system
Уникальный
String
UUID
1
_id
идентификатор
УС
Пример использования метода
Запрос:
138
POST api/v1/registration/accounting_system HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"sys_id": "6ea38541-ffc9-4db0-b963-7e3b0f9043e4",
"name": "Тестовая УС для компании ООО Медицина"
}
Получение результата:
{
"client_secret": "49781b3a-19d5-4ad7-b1b6-abb57e598d41",
"client_id": "7df0d06f-6510-44fe-a378-76cb53e2605f",
"account_system_id": "8425caca-a2fd-42b0-be02-3cdd1d262454"
}
6.1.2. Метод для регистрации пользователей (для резидентов страны)
Endpoint: POST <endpoint>/<version>/registration/user_resident
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sys_id
Идентификато
String
SysID
1
р субъекта
обращения в
«ИС
"Маркировка".
МДЛП»
public_cert
Публичный
String
BASE64
1
Необходимо
сертификат
использовать
пользователя
публичный
сертификат, а
не публичный
ключ
139
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
first_name
Имя
String
1
пользователя
last_name
Фамилия
String
1
пользователя
middle_name
Отчество
String
0
пользователя
email
Электронная
String
1
почта
phone
Контактный
String
\d{1,15}
0
телефон
position
Должность
String
0
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
идентификатор
пользователя
Пример использования метода
Запрос:
POST api/v1/registration/user_resident HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"sys_id": "6ea38541-ffc9-4db0-b963-7e3b0f9043e4",
"public_cert":
"MIIBjjCCAT2gAwIBAgIEWWJzHzAIBgYqhQMCAgMwMTELMAkGA1UEBhMCUlUxEjAQBgNVBAoMCUNyeXB0b1Byb
zEOMAwGA1UEAwwFQWxpYXMwHhcNMTcxMTEzMTczMjI4WhcNMTgxMTEzMTczMjI4WjAxMQswCQYDVQQGEwJSVTE
SMBAGA1UECgwJQ3J5cHRvUHJvMQ4wDAYDVQQDDAVBbGlhczBjMBwGBiqFAwICEzASBgcqhQMCAiQABgcqhQMCA
h4BA0MABEAIWARzAiI81k4i4Gz8EC7Ic01653JX5PCUfvgCBTpLduYtbTwLOwmGFcZzw9bwsxQpALqhcdRHxtx
1UEeNKJuMozswOTAOBgNVHQ8BAf8EBAMCA+gwEwYDVR0lBAwwCgYIKwYBBQUHAwIwEgYDVR0TAQH/BAgwBgEB/
wIBBTAIBgYqhQMCAgMDQQBL9CrIk0EgnMVr1J5dKbfXVFrhJxGxztFkTdmGkGJ6gHywB5Y9KpP67pv7I2bP1m1
140
ej9hu+C17GSJrWgMgq+UZ",
"first_name": "Иван",
"last_name": "Иванов",
"middle_name": " Иванович",
"email": "test@mail.ru",
"position": "Директор"
}
Получение результата:
{
"user_id": "8415ce27-2471-4597-9871-ae6b4734da9a"
}
6.1.3. Метод для регистрации пользователей (для нерезидентов страны)
Endpoint: POST <endpoint>/<version>/registration/user_nonresident
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sys_id
Идентификато
String
SysID
1
р субъекта
обращения в
«ИС
"Маркировка".
МДЛП»
email
Электронная
String
1
почта
phone
Контактный
String
\d{1,15}
0
телефон
password
Пароль
String
1
Выходная информация
По результатам выполнения клиент получает следующую информацию:
141
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
идентификатор
пользователя
Пример использования метода
Запрос:
POST api/v1/registration/user_nonresident HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"sys_id": "6ea38541-ffc9-4db0-b963-7e3b0f9043e4",
"password": "password123",
"email": "test@mail.ru"
}
Получение результата:
{
"user_id": "5b5540c4-fbb0-4ad7-a038-c8222affab3f"
}
6.1.4. Метод для получения информации о пользователе
Endpoint: GET <endpoint>/<version>/users/{user_id}
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
142
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
Параметр пути
идентификатор
(path param)
пользователя
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user
Пользователь
Object
GroupedUser
1
Пример использования метода
Запрос:
GET api/v1/users/5b5540c4-fbb0-4ad7-a038-c8222affab3f HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"user": {
"user_id": "5b5540c4-fbb0-4ad7-a038-c8222affab3f",
"first_name": "Петр",
"last_name": "Петров",
"login": "test@mail.ru",
"sys_id": "4b73cb20-69fb-44e6-ab17-65a9314e6068",
"is_admin": false,
"is_responsible": false,
"has_personal_data_agreement": true,
"groups": []
}
}
6.1.5. Метод для получения информации о настройках профиля текущего
пользователя
Endpoint: GET <endpoint>/<version>/users/current/preferences
143
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
language
Язык
String
^[a-z]{2}$
1
Доступные
интерфейса
значения:
пользователя
• ru
• en
Пример использования метода
Запрос:
GET api/v1/users/current/preferences HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"language": "ru"
}
6.1.6. Метод для изменения данных профиля пользователя
Endpoint: PUT <endpoint>/<version>/users/{user_id}
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
144
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
Параметр пути
идентификатор
(path param)
пользователя
user
Данные для
Object
UserEditProfile
1
изменения
Entry*
профиля
пользователя
• Нерезидентам при смене электронной почты необходимо пройти процедуру восстановления
пароля
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
PUT api/v1/users/5b5540c4-fbb0-4ad7-a038-c8222affab3f HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"user": {
"first_name": "Петр",
"last_name": "Петров",
"email": "test@mail.ru"
}
}
Получение результата:
HTTP код 200 OK
6.1.7. Метод для получения информации о текущем пользователе
Endpoint: GET <endpoint>/<version>/users/current
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
145
Параметры метода
Входная информация не требуется.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user
Пользователь
Object
GroupedUser
1
Пример использования метода
Запрос:
GET api/v1/users/current HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"user": {
"user_id": "5b5540c4-fbb0-4ad7-a038-c8222affab3f",
"sys_id": "4b73cb20-69fb-44e6-ab17-65a9314e6068",
"first_name": "Петр",
"last_name": "Петров",
"is_admin": false,
"login": "test@mail.ru",
"sys_id": "4b73cb20-69fb-44e6-ab17-65a9314e6068",
"is_responsible": false,
"has_personal_data_agreement": true,
"groups": []
}
}
6.1.8. Метод для изменения настроек профиля текущего пользователя
Endpoint: PUT <endpoint>/<version>/users/current/preferences
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
146
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
language
Язык
String
^[a-z]{2}$
1
Доступные
интерфейса
значения:
пользователя
• ru
• en
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
PUT api/v1/users/current/preferences HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"language": "ru"
}
Получение результата:
HTTP код 204 No Content
6.1.9. Метод для получения информации о зарегистрированных сертификатах
текущего пользователя
Endpoint: POST <endpoint>/<version>/users/current/keys
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
147
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
certs
Сертификаты
Array of
UserCert
1
(ключи)
Objects
пользователя
total
Общее
Number
1
количество
записей по
запросу
Формат объекта UserCert
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
public_cert_seri
Серийный
String
1
al_number
номер
публичного
сертификата
пользователя
public_cert_thu
Отпечаток
String
1
mbprint
публичного
сертификата
пользователя
valid_from
Действует с
String
1
valid_to
Действует до
String
1
org_name
Наименование
String
1
организации
owner
Владелец
String
1
148
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
inn
ИНН
String
1
position
Должность
String
0
owner_fio
Выписан на
String
1
issuer_name
Выдан
String
1
create_date
Дата создания
DateTime
1
записи
author_full_na
ФИО
String
0
me
пользователя,
внесшего
изменения
author_id
ИД
UUID
GUID
0
пользователя,
внесшего
изменения
Формат объекта UserCertsFilter
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
public_cert_seri
Серийный
String
0
al_number
номер
публичного
сертификата
пользователя
public_cert_thu
Отпечаток
String
0
mbprint
публичного
сертификата
пользователя
Пример использования метода
Запрос:
POST api/v1/users/current/keys HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
149

 

 

 

 

 

 

 

 

содержание      ..     1      2      3      4      ..