Главная Книги - Разные Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов (версия 4.65.0)
поиск по сайту правообладателям
|
|
содержание .. 1 2 ..
Описание API Государственной
информационной системы мониторинга и
движения лекарственных препаратов.
Протокол обмена интерфейсного уровня
Версия 4.65.0
Содержание
1. Используемые обозначения
11
2. Общие требования и ограничения по использованию методов интерфейса «ИС
"Маркировка". МДЛП»
15
2.1. Требования к квалификации разработчиков
15
2.2. Общие требования по использованию методов
15
3. Общая информация о методах интерфейса «ИС "Маркировка". МДЛП»
23
3.1. Доступ к методам интерфейса «ИС "Маркировка". МДЛП»
23
3.1.1. Ограничения по использованию методов аутентификации и авторизации
пользователей
23
3.2. Получение локализованных сообщений
23
4. Общие структуры данных, ограничения и коды завершения операций
25
4.1. Ограничения на форматы полей данных
25
4.2. Ограничения постраничного вывода
27
4.3. Коды завершения операций
29
4.4. Устаревшие методы и поля в методах в документации
29
4.5. Установка защищенного соединения к API по TLS (HTTPS)
30
4.6. Формат электронной цифровой подписи
30
4.7. Формат квалифицированного сертификата для ЭЦП
32
4.8. Требования к отправке документов, подписываемых ЭЦП
32
4.9. Описание идентификаторов, используемых в системе «ИС "Маркировка". МДЛП»
32
4.9.1. Идентификатор request_id
32
4.9.2. Идентификатор operation_id
32
4.9.3. Идентификатор document_id
32
4.9.4. Идентификатор session_ui
32
4.9.5. Идентификатор original_id
33
4.10. Формат ошибки
33
4.11. Список прав пользователей учетной системы (RightsEnum)
33
4.12. Список прав и методов, доступных пользователям с обезличенной УКЭП
37
4.13. Список статусов документа (DocStatusEnum)
46
4.14. Список типов групп прав (GroupTypeEnum)
46
4.15. Список типов аутентификации (AuthType)
48
4.16. Список статусов пользователя (UserStatus)
48
4.17. Список причин смены статуса пользователя (UserStatusReason)
48
4.18. Список типов задач на получение аналитических данных (TaskType)
48
4.19. Список типов задач для фильтрации аналитических данных (TaskType)
49
4.20. Список статусов обработки задачи на получение аналитических данных (TaskStatus) . . 49
4.21. Список типов заданий на получение аналитических данных по отчётам
50
4.22. Список статусов контейнера
50
4.23. Формат объекта Document
50
4.24. Формат объекта OutcomeDocument
51
4.25. Формат объекта IncomeDocument
52
4.26. Формат объекта DocFilter
53
4.27. Формат объекта DocOutcomeShowcaseFilter
55
4.28. Формат объекта DocOutcomeFilter
57
4.29. Формат объекта DocIncomeShowcaseFilter
58
4.30. Формат объекта DocIncomeFilter
60
4.31. Формат объекта BulkFilter
61
4.32. Формат объекта BulkFilterResponseItem
61
4.33. Формат объекта Group
62
4.34. Формат объекта GroupInfo
63
4.35. Формат объекта User
63
4.36. Формат объекта GroupedUser
64
4.37. Формат объекта UserInfo
65
4.38. Формат объекта AccountSystem
66
4.39. Формат объекта RightsInfo
66
4.40. Формат объекта Address
66
4.41. Формат объекта ForeignAddress
67
4.42. Формат объекта UserEditProfileEntry
67
4.43. Формат объекта Packer1
68
4.44. Формат объекта Packer2_3
68
4.45. Формат объекта QA
69
4.46. Формат объекта SGTIN
69
4.47. Формат объекта SgtinExtended
72
4.48. Формат объекта SgtinBillingInformation
74
4.49. Формат объекта SgtinPaymentInformation (Устарел)
75
4.50. Формат объекта DeviceContractInfoEntry
75
4.51. Формат объекта SgtinsFilter
75
4.52. Формат объекта LicenseEntry
76
4.53. Формат объекта LicenseApiFilter
77
4.54. Формат объекта MedProductsFilter
78
4.55. Формат объекта PublicSgtin
79
4.56. Формат объекта GtinInfo
81
4.57. Формат объекта DocumentInfo
86
4.58. Формат объекта ExtendedGroupInfo
87
4.59. Формат объекта Task
88
4.60. Формат объекта FileInfo
89
4.61. Формат объекта SgtinMarketplaceInformation
89
4.62. Формат объекта GroupFilter
90
4.63. Список возможных статусов КИЗ
90
4.64. Типы эмиссии
92
4.65. Статусы кодов маркировки в производственной серии
93
4.66. Типы вывода из оборота
93
4.67. Способы выбытия
93
4.68. Источники данных
94
4.69. Типы входящих документов для параметра doc_type
94
4.70. Типы исходящих документов для параметра doc_type
95
4.71. Типы выбытия
98
5. Загрузка документов
99
5.1. Отправка документа
99
5.2. Отправка документа большого объема
101
5.3. Загрузка документа большого объема
103
5.4. Завершение отправки документа
104
5.5. Запуск обработки группы документов
105
5.6. Проверка возможности запуска группы документов
107
5.7. Получение информации о группе документов
109
5.8. Получение информации по имеющимся группам документов
111
5.9. Получение информации об ограничении размера небольших документов
113
5.10. Отмена отправки документа
114
5.11. Получение списка исходящих документов
115
5.12. Получение списка исходящих документов из витрины документов
117
5.13. Получение списка входящих документов
119
5.14. Получение списка входящих документов из витрины документов
121
5.15. Передача информации о прочтении документа
124
5.16. Получение метаданных документа
125
5.17. Получение документа по идентификатору
127
5.18. Получение списка документов по идентификатору запроса
128
5.19. Получение квитанции по номеру исходящего документа
129
5.20. Получение электронной подписи исходящего документа
131
5.21. Прослеживание документов по отчёту из СУЗ
132
5.22. Скачивание документа по идентификатору
135
6. Пользователи и учетные системы
138
6.1. Регистрация учетной системы и пользователей
138
6.1.1. Метод для регистрации учетной системы
138
6.1.2. Метод для регистрации пользователей (для резидентов страны)
139
6.1.3. Метод для регистрации пользователей (для нерезидентов страны)
141
6.1.4. Метод для получения информации о пользователе
142
6.1.5. Метод для получения информации о настройках профиля текущего пользователя . 143
6.1.6. Метод для изменения данных профиля пользователя
144
6.1.7. Метод для получения информации о текущем пользователе
145
6.1.8. Метод для изменения настроек профиля текущего пользователя
146
6.1.9. Метод для получения информации о зарегистрированных сертификатах текущего
пользователя
147
6.1.10. Метод для получения информации о зарегистрированных сертификатах
пользователя
150
6.1.11. Метод для получения информации об УС
152
6.2. Аутентификация и авторизация пользователей
153
6.2.1. Метод для получения кода аутентификации
153
6.2.2. Метод для получения ключа сессии
155
6.2.3. Метод для выхода из системы
157
6.3. Удаление учетных систем и пользователей учетной системы
158
6.3.1. Метод для удаления пользователей учетной системы
158
6.3.2. Метод для удаления учетной системы
159
6.4. Изменение ЭП пользователя (для резидентов)
159
6.4.1. Метод для добавления ЭП пользователя (для резидентов)
159
6.4.2. Метод для удаления ЭП пользователя (для резидентов)
161
6.5. Изменение пароля пользователя (для нерезидентов)
162
6.5.1. Метод для изменения пароля пользователя (для нерезидентов)
162
6.6. Группы прав пользователей
163
6.6.1. Метод для получения информации о существующих правах
163
6.6.2. Метод для получения информации о правах текущего пользователя
165
6.6.3. Метод для создания группы прав пользователей
166
6.6.4. Метод для получения информации о группе прав пользователей
167
6.6.5. Метод для получения информации о пользователях группы
168
6.6.6. Метод для изменения группы прав пользователей
169
6.6.7. Метод для удаления группы прав пользователей
170
6.6.8. Метод для добавления пользователя в группу прав пользователей
171
6.6.9. Метод для удаления пользователя из группы прав пользователей
172
6.6.10. Метод для получения списка групп прав пользователей (Устарел)
173
6.6.11. Метод для поиска списка групп прав пользователей по фильтру
175
6.7. Поиск по зарегистрированным пользователям
177
6.7.1. Метод для поиска по зарегистрированным пользователям (Устарел)
177
6.7.2. Метод для поиска зарегистрированных пользователей по фильтру
178
6.8. Поиск по УС
181
6.8.1. Метод для поиска по УС (Устарел)
181
6.8.2. Метод для поиска УС по фильтру
182
6.8.3. Метод добавления ЭП пользователя для самого себя
184
6.8.4. Метод для получения информации о своих зарегистрированных сертификатах
пользователя
186
6.8.5. Метод для поиска списка собственных групп прав по фильтру
187
6.8.6. Метод для получения информации о вариантах собственных прав
189
7. Получение справочной информации
192
7.1. Получение информации из реестра ЕГРЮЛ
192
7.1.1. Получение данных записи ЕГРЮЛ
192
7.2. Получение информации из реестра ЕГРИП
193
7.2.1. Получение данных записи ЕГРИП
193
7.3. Получение информации из реестра аккредитованных филиалов и представительств . . . 194
7.3.1. Получение записи реестра РАФП
194
7.4. Получение информации из реестра налоговой задолженности
195
7.4.1. Получение информации о задолженности (Устарел)
195
7.5. Получение информации из реестра ГАР/ФИАС
196
7.5.1. Получение текстового адреса по идентификаторам ГАР/ФИАС
196
7.6. Получение информации из реестра лицензий на производство
198
7.6.1. Получение информации о лицензиях на производство
198
7.6.2. Метод фильтрации лицензий на производство
200
7.6.3. Метод для актуализации данных текущего участника из реестра лицензий на
производство
202
7.7. Получение информации из реестра лицензий на фармакологическую деятельность
202
7.7.1. Получение информации о лицензиях на фарм. деятельность
202
7.7.2. Метод фильтрации лицензий на фарм. деятельность
204
7.7.3. Метод для актуализации данных текущего участника из реестра лицензий на фарм.
деятельность
206
7.8. Получение информации из реестра адресов
207
7.8.1. Метод для получения информации о всех местах осуществления деятельности и
местах ответственного хранения участника
207
7.9. Получение информации из реестра стран и субъектов РФ
208
7.9.1. Метод для получения списка стран
208
7.9.2. Метод для получения списка субъектов РФ
210
7.10. Получение информации из реестра ЕСКЛП
212
7.10.1. Фильтрация по реестру ЕСКЛП
212
7.11. Получение информации из реестра мест таможенного контроля
224
7.11.1. Фильтрация по реестру
224
8. Получение и управление информацией в реестрах «ИС "Маркировка". МДЛП»
228
8.1. Реестр мест осуществления деятельности
228
8.1.1. Получение информации о местах осуществления деятельности (Устарел)
228
8.1.2. Метод для поиска информации о местах осуществления деятельности по фильтру. 229
8.1.3. Получение перечня мест осуществления деятельности в системе
239
8.1.4. Получение информации о конкретном месте осуществления деятельности
245
8.1.5. Метод для регистрации места осуществления деятельности
248
8.1.6. Метод для получения информации об адресах текущего участника (Устарел)
249
8.1.7. Метод для редактирования параметров МД для аптек
251
8.2. Реестр мест ответственного хранения
256
8.2.1. Получение информации о местах ответственного хранения (Устарел)
256
8.2.2. Метод для поиска информации о местах ответственного хранения по фильтру
257
8.2.3. Получение перечня мест ответственного хранения в системе
262
8.2.4. Получение информации о конкретном месте ответственного хранения
267
8.2.5. Метод для регистрации места ответственного хранения
268
8.2.6. Метод получения информации об адресах искомого участника для регистрации
мест ответственного хранения или отправки документов
270
8.2.7. Метод активации и блокирования МД
272
8.2.8. Метод активации и блокирования МОХ
273
8.3. Получение информации из реестров КИЗ
274
8.3.1. Метод поиска по реестрам КИЗ
274
8.3.2. Метод поиска по реестрам КИЗ по списку значений
279
8.3.3. Метод поиска по общедоступным реестрам КИЗ по списку значений
283
8.3.4. Метод поиска по общедоступному реестру КИЗ в архивном хранилище по списку
значений
285
8.3.5. Метод для получения из реестров КИЗ детальной информации о КИЗ и связанным
с ним ЛП
287
8.3.6. Метод для получения детальной информации о КИЗ в архивном хранилище и
связанным с ним ЛП
293
8.3.7. Метод для получения перечня документов по идентификатору КИЗ
298
8.3.8. Метод для получения перечня документов по идентификатору КИЗ из архивного
хранилища
300
8.3.9. Метод поиска по реестрам КИЗ всех записей со статусом 'Оборот приостановлен' . 301
8.3.10. Метод для поиска по реестру КИЗ записей для вывода из оборота по чеку от
контрольно-кассовой техники (ККТ)
307
8.3.11. Метод для поиска по реестру КИЗ записей для вывода из оборота через РВ
314
8.4. Получение сведений по маркированным и ввезенным товарам
318
8.4.1. Метод для получения сведений по маркированным и ввезенным товарам
318
8.4.2. Метод валидации кода маркировки
323
8.4.3. Метод верификации кода маркировки и криптохвоста
324
8.5. Получение информации о третичной упаковке
326
8.5.1. Метод для получения информации об иерархии вложенности третичной упаковки. 326
8.5.2. Метод для получения информации о КИЗ в третичной упаковке
329
8.5.3. Метод для получения информации о полной иерархии вложенности третичной
упаковки
332
8.5.4. Метод для получения информации о полной иерархии вложенности третичной
упаковки для нескольких SSCC
336
8.5.5. Метод для получения информации о существующем SSCC
341
8.5.6. Метод по получению информации о SSCC для принятия решения о принятии на
баланс
344
8.6. Получение информации из реестра производимых ЛП
346
8.6.1. Метод для получения информации из реестра производимых организацией ЛП . . . 346
8.6.2. Метод для получения детальной информации о производимом организацией ЛП . . 355
8.6.3. Метод для поиска публичной информации в реестре производимых ЛП
365
8.6.4. Метод для получения публичной информации о производимом ЛП
373
8.7. Реестр регистрации иностранных контрагентов
379
8.7.1. Метод для регистрации иностранного контрагента
379
8.7.2. Метод для просмотра заявок на регистрацию иностранных контрагентов
381
8.8. Получение информации из реестра доверенных контрагентов
384
8.8.1. Метод добавления доверенного контрагента
384
8.8.2. Метод удаления доверенного контрагента
386
8.8.3. Метод фильтрации доверенных контрагентов
387
8.8.4. Метод проверки доверенных контрагентов
389
8.9. Получение информации о субъектах обращения (участниках ИС "Маркировка")
390
8.9.1. Метод фильтрации по субъектам обращения
391
8.10. Получение информации об участнике
401
8.10.1. Метод для получения информации о регистрации в организации для текущего
пользователя
401
8.10.2. Метод для изменения данных организации, в которой зарегистрирован текущий
пользователь
409
8.10.3. Метод для получения информации о лицевых счетах
411
8.11. Получение информации из реестра регистраторов
412
8.11.1. Фильтрация по реестру регистраторов эмиссии
412
8.11.2. Фильтрация по реестру регистраторов выбытия
417
8.12. Получение информации из реестра решений о приостановке КИЗ
423
8.12.1. Фильтрация по реестру решений о приостановке КИЗ
423
8.12.2. Получение перечня КИЗ по конкретному решению о приостановке
427
8.13. Получение информации из реестра решений о вводе лекарственных препаратов в
гражданский оборот
429
8.13.1. Фильтрация по реестру решений о вводе лекарственных препаратов в
гражданский оборот
429
8.14. Получение информации из реестра производственных серий
434
8.14.1. Получение сводной информации распределения ЛП (временно приостановлен). 434
8.15. Получение информации из реестра деклараций (импортные ЛП)
438
8.15.1. Фильтрация по реестру деклараций (импортные ЛП)
438
8.16. Получение информации из реестра партий, ввозимых из ЕАЭС
443
8.16.1. Фильтрация по реестру партий, ввозимых из ЕАЭС
443
9. Работа с инструкциями и изображениями упаковок лекарственных препаратов
450
9.1. Требования к инструкциям и изображениям
450
9.1.1. Требования к инструкции в JSON
450
9.1.2. Требования к инструкции в PDF
457
9.1.3. Требования к изображениям
457
9.2. Метод создания контейнера
457
9.3. Метод редактирования контейнера
458
9.4. Метод скачивания содержимого контейнера
460
9.5. Метод отображения реестра контейнеров
461
9.6. Метод передачи контейнера на модерацию
463
9.7. Метод настройки автоматического присвоения контейнеров к GTIN
464
9.8. Метод создания связи между контейнером и серией
466
10. Получение аналитических данных
468
10.1. Создание задачи
468
10.2. Просмотр информации о задаче пользователя
470
10.3. Просмотр списка задач пользователя
472
10.4. Получение результата задачи
476
10.5. Отмена задачи
478
10.6. Удаление задачи
479
10.7. Просмотр списка установленных ограничений на количество задач
480
10.8. Список возможных кодов ошибок
481
10.9. Параметры фильтрации и описание доступных полей для выгрузок данных
481
10.9.1. Выгрузка детализированной информации по движению ЛП (временно
приостановлен)
481
10.9.1.1. Параметры фильтрации
482
10.9.1.2. Формат результата выгрузки
482
10.9.2. Выгрузка иерархии по SGTIN
489
10.9.2.1. Параметры фильтрации
489
10.9.2.2. Формат результата выгрузки
489
10.9.3. Выгрузка информации о количестве SGTIN и их сериях в SSCC
492
10.9.3.1. Параметры фильтрации
492
10.9.3.2. Доступные поля выгрузки
492
10.9.4. Выгрузка общедоступной информации по SGTIN
493
10.9.4.1. Параметры фильтрации
493
10.9.4.2. Формат результата выгрузки
494
10.9.5. Выгрузка отчёта "Мой виртуальный склад" (Устарел)
497
10.9.5.1. Параметры фильтрации
497
10.9.5.2. Доступные поля выгрузки
497
10.9.6. Выгрузка из реестра серий
498
10.9.6.1. Параметры фильтрации
498
10.9.6.2. Доступные поля выгрузки
499
10.9.7. Выгрузка общедоступной информации по SGTIN из архива
500
10.9.7.1. Параметры фильтрации
500
10.9.7.2. Доступные поля выгрузки
501
10.9.8. Выгрузка списка успешно обработанных SGTIN по id исходного XML-документа 504
10.9.8.1. Параметры фильтрации
504
10.9.8.2. Доступные поля выгрузки
504
11. Аналитические данные по отчётам
506
11.1. Метод создания нового задания на выгрузку
506
11.2. Метод получения статуса задания на выгрузку
508
11.3. Метод получения статусов заданий на выгрузку
510
11.4. Метод получения результирующих идентификаторов выгрузок данных
514
11.5. Метод получения выгрузки
517
11.6. Метод удаления файла выгрузки
518
11.7. Параметры фильтрации и описание доступных полей для выгрузок
519
11.7.1. Общий отчёт по ценам
519
11.7.1.1. Параметры фильтрации
519
11.7.1.2. Доступные поля выгрузки
527
11.7.2. Общий отчёт по выбытию ЛП
527
11.7.2.1. Параметры фильтрации
528
11.7.2.2. Доступные поля выгрузки
533
11.7.3. Общий отчёт по движению ЛП
534
11.7.3.1. Параметры фильтрации
534
11.7.3.2. Доступные поля выгрузки
537
11.7.4. Общий отчёт по остаткам ЛП
537
11.7.4.1. Параметры фильтрации
537
11.7.4.2. Доступные поля выгрузки
538
11.7.5. Мой виртуальный склад (новый)
539
11.7.5.1. Параметры фильтрации
539
11.7.5.2. Доступные поля выгрузки
540
12. Получение событий, связанных с выбытием КИЗ
542
12.1. Общие правила работы
542
12.2. Список доступных типов событий вывода из оборота (WithdrawalEventType)
542
12.3. Создание подписки на получение событий, связанных с выбытием КИЗ
544
12.4. Получение списка подписок
546
12.5. Изменение подписки на получение событий, связанных с выбытием КИЗ
547
12.6. Получение событий, связанных с выбытием КИЗ
549
12.7. Отписка от получения событий, связанных с выбытием КИЗ
551
12.8. Формат ответа в случае ошибки
552
12.9. Список возможных кодов ошибок
552
13. Часто задаваемые вопросы
553
История изменений
556
1. Используемые обозначения
7ВЗН
Программа 7 высокозатратных нозологий по централизованной закупке препаратов для
больных гемофилией, муковисцидозом, гипофизарным нанизмом, болезнью Гоше,
злокачественными новообразованиями лимфоидной, кроветворной и родственных им тканей
и рассеянным склерозом.
API
Application Programming Interface (англ.) - Программный интерфейс приложения
GS1
Международная организация, ведающая вопросами стандартизации учёта и штрихового
кодирования логистических единиц.
GTIN
Global Trade Item Number (англ.) - Глобальный идентификационный номер, присваиваемый
единице товара (продукции) национальной организацией GS1 в соответствии с правилами,
установленными стандартами системы GS1, наносимый в виде штрихового кода на каждую
единицу товара (продукции) в целях ее однозначной идентификации в мировом
экономическом пространстве.
ITIN
Individual Taxpayer Identification Number (англ.) - Индивидуальный идентификационный
номер налогоплательщика, выданный Налоговым управлением США (IRS). Это уникальный
номер, присваиваемый лицам, которые обязаны оплачивать подоходный налог в Соединенных
Штатах, но при этом не имеют Номер социального страхования (SSN) и не имеют права
получить этот номер. В «ИС "Маркировка". МДЛП» используется как аналог ИНН для всех
участников-нерезидентов.
SGTIN
Serialised Global Trade Item Number (англ.) - Индивидуальный идентификационный код
потребительской упаковки для прослеживаемости в «ИС "Маркировка". МДЛП» (GTIN +
индивидуальный серийный номер вторичной (потребительской) упаковки или первичной
упаковки, в случае отсутствия вторичной).
SSCC
Serial Shipping Container Code (англ.) - Индивидуальный серийный номер групповой
третичной заводской транспортной упаковки, КИЗ в виде линейного штрихового кода
Code128.
WebDAV
Web Distributed Authoring and Versioning (англ.) - набор расширений и дополнений к
протоколу HTTP, поддерживающих совместную работу пользователей над редактированием
файлов и управление файлами на удаленных веб-серверах.
БД
База данных.
БИК
Банковский идентификационный код - уникальный идентификатор банка, используемый в
11
платежных документах на территории Российской Федерации.
ГАР
Государственный адресный реестр.
ЕАЭС
Евразийский экономический союз.
ЕГРИП
Единый государственный реестр индивидуальных предпринимателей.
ЕГРЮЛ
Единый государственный реестр юридических лиц.
ЕСКЛП
Единый справочник-каталог лекарственных препаратов МинЗдрава России.
ЖНВЛП
Жизненно необходимые и важнейшие лекарственные препараты.
ЗТК
Зона таможенного контроля.
ИНН
Идентификационный номер налогоплательщика.
ИС "Маркировка". МДЛП
Информационная система "Маркировка движения лекарственных препаратов".
ИС МП
Информационная система маркировки и прослеживаемости - информационная система,
созданная в целях автоматизации задач мониторинга движения товаров, подлежащих
обязательной маркировке средствами идентификации, включая различные товарные группы.
ИС
Информационная система.
КИЗ
Контрольно-идентификационный знак. В терминах «ИС "Маркировка". МДЛП» это SGTIN и
SSCC.
ККТ
Контрольно-кассовая техника.
КМ
Код маркировки.
ИТИН
См. ITIN.
КПП
Код причины постановки на учет.
12
ЛП
Лекарственный препарат.
ЛФ
Лекарственная форма.
МД
Место деятельности.
МНН
Международное непатентованное наименование.
МОХ
Место ответственного хранения.
ОГРН
Основной государственный регистрационный номер.
ОГРНИП
Основной государственный регистрационный номер индивидуального предпринимателя.
ОКТМО
Общероссийский классификатор территорий муниципальных образований.
ОФД
Оператор фискальных данных.
ПО
Программное обеспечение.
РВ
Регистратор выбытия.
РУ
Регистрационное удостоверение.
РЭ
Регистратор эмиссии, устройство автоматизированной СКЗКМ, предназначенное для заказа
кодов маркировки и регистрации сведений о выпуске маркированных товаров.
СВХ
Склад временного хранения.
СКЗКМ
Система криптографической защиты кодов маркировки.
СМЭВ
Система межведомственного электронного взаимодействия.
СУЗ
Станция управления заказами кодов маркировки.
13
ТНВЭД ЕАЭС
Товарная номенклатура внешнеэкономической деятельности Евразийского экономического
союза.
ТС
Таможенная служба.
УКЭП
Усиленная квалифицированная электронная подпись.
УС
Учётная система.
УСО
Универсальная система обмена.
УЭО
Уполномоченный экономический оператор - любое юридическое лицо, вовлеченное в
международное движение товаров и признанное национальным таможенным органом или от
его имени как соответствующее стандартам безопасности ВТамО или аналогичной системы
поставок.
ФИАС
Федеральная информационная адресная система.
ФТС
Федеральная таможенная служба.
14
2. Общие требования и ограничения по
использованию методов интерфейса «ИС
"Маркировка". МДЛП»
2.1. Требования к квалификации разработчиков
Данное руководство предполагает, что разработчик программного обеспечения (далее - ПО),
используемого участником обращения лекарственных препаратов (далее
- Участник),
использующий описанные ниже методы интерфейса «ИС "Маркировка". МДЛП» (далее - API),
удовлетворяет следующим требованиям:
• владение навыками разработки клиентской части для REST API сервисов;
• знание протоколов HTTP, HTTPS, SSL (RSA и ГОСТ алгоритмы);
• знание принципов работы систем крипто защиты информации (далее
- СКЗИ) и
использования усиленной квалифицированной электронной подписи (далее - УКЭП).
2.2. Общие требования по использованию методов
Принципы взаимодействия с ИС "Маркировка" носят информационный характер, в этой связи
использование методов API подразумевает, что разрабатываемое ПО на стороне Участника,
будет выполнять следующие требования:
• обрабатывать статус ответа методов API;
• для методов, указанных в таблице ниже, соблюдать временной интервал между вызовами.
ООО "Оператор-ЦРПТ" оставляет за собой право изменять интервалы между вызовами методов
API. В случае внесения изменений данная информация будет отображена в новой версии
текущего документа.
ООО "Оператор-ЦРПТ", при выявлении систематических нарушений установленных интервалов
со стороны Участника, вправе устанавливать отдельным пользователям индивидуальные
интервалы между вызовами определенных методов API.
Действующие индивидуальные интервалы между вызовами API сообщаются пользователю в
тексте и в заголовке Retry-After ошибки 429.
Обратить внимание: Ограничения на временной интервал вызовов действуют в рамках
учетной записи пользователя, а не Участника в целом.
Таблица 1. Интервал между вызовами методов API
Наименование метода
Интерв
ал,
секунда
Отправка документа POST //documents/send
0,5
Отправка документа большого объема POST //documents/send_large
0,5
Загрузка документа большого объема PUT //webdav/upload/{doc_id}/{doc_id}
0,5
Завершение отправки документа POST //documents/send_finished
0,5
15
Наименование метода
Интерв
ал,
секунда
Запуск обработки группы документов POST //documents/bulk
0,5
Проверка возможности запуска группы документов POST //documents/bulk/check
0,5
Получение информации о группе документов GET //documents/bulk/{bulk_id}
0,5
Получение информации по имеющимся группам документов POST
0,5
//documents/bulk/filter
Отмена отправки документа POST //documents/cancel
0,5
Получение информации об ограничении размера небольших документов GET
0,5
//documents/doc_size
Получение списка исходящих документов POST //documents/outcome
1
Получение списка исходящих документов из витрины документов POST
1
//documents/showcase/outcome
Получение списка входящих документов POST //documents/income
1
Получение списка входящих документов из витрины документов POST
1
//documents/showcase/income
Получение метаданных документа GET //documents/{docId}
0,5
Получение документа по идентификатору GET //documents/download/{docId}
0,5
Получение списка документов по идентификатору запроса GET
0,5
//documents/request/{request_id}
Получение квитанции по номеру исходящего документа GET
0,5
//documents/{docId}/ticket
Получение электронной подписи исходящего документа GET
0,5
//documents/{docId}/signature
Скачивание документа по идентификатору GET //webdav/upload/{doc_id}/{doc_id}
0,5
Метод для регистрации учетной системы POST //registration/accounting_system
0,5
Метод для регистрации пользователей (для резидентов страны) POST
0,5
//registration/user_resident
Метод для регистрации пользователей (для нерезидентов страны) POST
0,5
//registration/user_nonresident
Метод для получения информации о пользователе GET //users/{user_id}
0,5
Метод для изменения данных профиля пользователя PUT //users/{user_id}
0,5
Метод для получения информации о текущем пользователе GET //users/current
0,5
Метод для получения информации о зарегистрированных сертификатах текущего
0,5
пользователя POST //users/current/keys
Метод для получения информации о зарегистрированных сертификатах пользователя
0,5
POST //users/{user_id}/keys
16
Наименование метода
Интерв
ал,
секунда
Метод для получения информации об УС GET //account_systems/{account_system_id}
0,5
Метод для получения кода аутентификации POST //auth
1 сек (не
более
1000
запросо
в в
сутки на
пользов
ателя)
Метод для получения ключа сессии POST //token
1 сек (не
более
1000
запросо
в в
сутки на
пользов
ателя)
Метод для выхода из системы GET //auth/logout
1 сек (не
более
1000
запросо
в в
сутки на
пользов
ателя)
Метод для удаления пользователей учетной системы DELETE //users/{user_id}
0,5
Метод для удаления учетной системы DELETE //account_systems/{account_system_id}
0,5
Метод для добавления ЭП пользователя (для резидентов) POST
0,5
//users/{user_id}/add_key
Метод для удаления ЭП пользователя (для резидентов) DELETE
0,5
//users/{user_id}/delete_key
Метод для изменения пароля пользователя (для нерезидентов) PUT
0,5
//users/{user_id}/change_password
Метод для получения информации о существующих правах GET //rights/about
0,5
Метод для получения информации о правах текущего пользователя GET
0,5
//rights/current
Метод для создания группы прав пользователей POST //rights/create_group
0,5
Метод для получения информации о пользователях группы GET
0,5
//rights/{group_id}/users
Метод для получения информации о группе прав пользователей GET
0,5
//rights/{group_id}
17
Наименование метода
Интерв
ал,
секунда
Метод для изменения группы прав пользователей PUT //rights/{group_id}
0,5
Метод для удаления группы прав пользователей DELETE //rights/{group_id}
0,5
Метод для добавления пользователя в группу прав пользователей POST
0,5
//rights/{group_id}/user_add
Метод для удаления пользователя из группы прав пользователей DELETE
0,5
//rights/{group_id}/{user_id}
Метод для получения списка групп прав пользователей (Устарел) POST //rights/list
0,5
Метод для поиска списка групп прав пользователей по фильтру POST //rights/filter
0,5
Метод для поиска по зарегистрированным пользователям (Устарел) POST //users/find
0,5
Метод для поиска зарегистрированных пользователей по фильтру POST //users/filter
0,5
Метод для поиска по УС (Устарел) POST //account_systems/find
0,5
Метод для поиска УС по фильтру POST //account_systems/filter
0,5
Получение данных записи ЕГРЮЛ GET //reestr/egrul
0,5
Получение данных записи ЕГРИП GET //reestr/egrip
0,5
Получение записи реестра РАФП GET //reestr/rafp
0,5
Получение информации о задолженности (Устарел) GET //reestr/dues
0,5
Получение текстового адреса по идентификаторам ГАР/ФИАС POST
0,5
//reestr/fias/resolve
Получение информации о лицензиях на производство GET //reestr/prod_licenses
0,5
Получение информации о лицензиях на фарм. деятельность GET
0,5
//reestr/pharm_licenses
Получение информации о местах осуществления деятельности (Устарел) GET
0,5
//reestr/branches
Метод для поиска информации о местах осуществления деятельности по фильтру
0,5
POST //reestr/branches/filter
Получение информации о конкретном месте осуществления деятельности GET
0,5
//reestr/branches/{branch_id}
Метод для регистрации места осуществления деятельности POST
0,5
//reestr/branches/register
Метод для получения информации об адресах текущего участника (Устарел) GET
0,5
//reestr/branches/available_branches_addresses
Метод для редактирования параметров МД для аптек PUT //reestr/branches/info
0,5
Получение информации о местах ответственного хранения (Устарел) GET
0,5
//reestr/warehouses
18
Наименование метода
Интерв
ал,
секунда
Метод для поиска информации о местах ответственного хранения по фильтру POST
0,5
//reestr/warehouses/filter
Получение перечня мест ответственного хранения в системе POST
5
//reestr/warehouses/public/filter
Получение информации о конкретном месте ответственного хранения GET
0,5
//reestr/warehouses/{warehouse_id}
Метод для регистрации места ответственного хранения POST
0,5
//reestr/warehouses/register
Метод получения информации об адресах искомого участника для регистрации мест
0,5
ответственного хранения или отправки документов POST
//reestr/warehouses/available_safe_warehouses_addresses
Метод для получения информации о всех местах осуществления деятельности и
0,5
местах ответственного хранения участника GET //reestr/address/all
Метод для получения списка стран POST //reestr/area/countries
0,5
Метод для получения списка субъектов РФ POST //reestr/reestr/area/regions
0,5
Фильтрация по реестру ЕСКЛП POST //reestr/esklp/filter
0,5
Метод поиска по реестрам КИЗ POST //reestr/sgtin/filter
5
Метод поиска по реестрам КИЗ по списку значений POST //reestr/sgtin/sgtins-by-list
10
Метод для получения из реестров КИЗ детальной информации о КИЗ и связанным с
5
ним ЛП GET //reestr/sgtin/{sgtin}
Метод поиска по реестрам КИЗ всех записей со статусом 'Оборот приостановлен'
0,5
POST //reestr/sgtin/on_hold
Метод для получения информации об иерархии вложенности третичной упаковки
20
GET //reestr/sscc/{sscc}/hierarchy
Метод для получения информации о КИЗ в третичной упаковке POST
5
//reestr/sscc/{sscc}/sgtins
Метод для получения информации из реестра производимых организацией ЛП POST
0,5
//reestr/med_products/current
Метод для получения детальной информации о производимом организацией ЛП GET
0,5
//reestr/med_products/{gtin}
Метод для регистрации иностранного контрагента POST
0,5
//reestr/foreign_counterparty/register
Метод для просмотра заявок на регистрацию иностранных контрагентов POST
0,5
//reestr/foreign_counterparty/filter
Метод добавления доверенного контрагента POST //reestr/trusted_partners/add
0,5
Метод удаления доверенного контрагента POST //reestr/trusted_partners/delete
0,5
Метод фильтрации доверенных контрагентов POST //reestr/trusted_partners/filter
0,5
19
Наименование метода
Интерв
ал,
секунда
Метод проверки доверенных контрагентов GET //reestr/trusted_partners/check/{inn}
3600 (1
час)
Метод фильтрации по субъектам обращения POST //reestr_partners/filter
1
Метод для получения информации о регистрации в организации для текущего
0,5
пользователя GET //members/current
Получение информации из реестра мест таможенного контроля POST
0,5
//reestr/customs_points/filter
Фильтрация по реестру регистраторов эмиссии POST //reestr/registration-
1
devices/emission/filter
Фильтрация по реестру регистраторов выбытия POST //reestr/registration-
1
devices/withdrawal/filter
Метод поиска по общедоступным реестрам КИЗ по списку значений POST
5
//reestr/sgtin/public/sgtins-by-list
Метод для получения публичной информации о производимом ЛП GET
1
//reestr/med_products/public/{gtin}
Метод для поиска по реестру КИЗ записей для вывода из оборота по чеку от
1
контрольно-кассовой техники (ККТ) POST //reestr/sgtin/kkt/awaiting-withdrawal/filter
Метод для актуализации данных текущего участника из реестра лицензий на
86400 (1
производство POST //reestr/prod_licenses/resync
сутки)
Метод для актуализации данных текущего участника из реестра лицензий на фарм.
14400 (4
деятельность POST //reestr/pharm_licenses/resync
часа)
Метод фильтрации лицензий на фарм. деятельность POST //reestr/pharm_licenses
0,5
Метод фильтрации лицензий на производство POST //reestr/prod_licenses
0,5
Метод для поиска публичной информации в реестре производимых ЛП POST
5
//reestr/med_products/public/filter
Фильтрация по реестру решений о приостановке КИЗ POST //reestr/paused-circulation-
1
decisions/filter
Получение перечня КИЗ по конкретному решению о приостановке POST
1
//reestr/paused-circulation-decisions/{halt_id}/sgtins/filter
Прослеживание документов по отчёту из СУЗ POST //documents/skzkm-traces/filter
1
Метод для поиска по реестру КИЗ записей для вывода из оборота через РВ POST
1
//reestr/sgtin/device/awaiting-withdrawal/filter
Метод для получения информации о полной иерархии вложенности третичной
30
упаковки GET //reestr/sscc/{sscc}/full-hierarchy
Метод для получения информации о полной иерархии вложенности третичной
30
упаковки для нескольких SSCC GET //reestr/sscc/full-hierarchy
20
Наименование метода
Интерв
ал,
секунда
Получение сводной информации распределения ЛП (временно приостановлен)
1
POST //reestr/batches/short-distribution
Фильтрация по реестру решений о вводе лекарственных препаратов в гражданский
0,5
оборот POST //reestr/lp-in-circulation-decisions/filter
Фильтрация по реестру деклараций (импортные ЛП) POST //reestr/declarations/filter
0,5
Фильтрация по реестру партий, ввозимых из ЕАЭС POST //reestr/consignments/filter
0,5
Передача информации о прочтении документа POST //documents/income/mark_read
0,5
Создание задачи POST //export/tasks/{task_type}
30
Просмотр информации о задаче пользователя GET //export/tasks/{task_id}
0,5
Просмотр списка задач пользователя POST //export/tasks/filter
0,5
Получение результата задачи GET //export/tasks/{task_id}/result
0,5
Отмена задачи POST //export/tasks/{task_id}/cancel
0,5
Удаление задачи DELETE //export/tasks/{task_id}
0,5
Просмотр списка установленных ограничений на количество задач GET
0,5
//export/tasks/settings
Метод создания нового задания на выгрузку POST //data/export/tasks
60
Метод получения статуса задания на выгрузку GET //data/export/tasks/{task_id}
60
Метод получения статусов заданий на выгрузку POST //data/export/tasks/search
60
Метод получения результирующих идентификаторов выгрузок данных GET
60
//data/export/results
Метод получения выгрузки GET //data/export/results/{result_id}/file
60
Метод удаления файла выгрузки DELETE //data/export/results/{result_id}
60
Метод для получения перечня документов по идентификатору КИЗ GET
0,5
//reestr/sgtin/documents
Метод для получения перечня документов по идентификатору КИЗ из архивного
0,5
хранилища GET //reestr/sgtin/archive/documents
Метод для получения детальной информации о КИЗ в архивном хранилище и
5
связанным с ним ЛП GET //reestr/sgtin/archive/{sgtin}
Метод поиска по общедоступному реестру КИЗ в архивном хранилище по списку
10
значений POST //reestr/sgtin/public/archive/sgtins-by-list
Метод для получения сведений по маркированным и ввезенным товарам POST
5
//reestr/marking_lp
Метод валидации кода маркировки POST //sgtin/validate
0,5
Метод верификации кода маркировки и криптохвоста POST //sgtin/verification
30
21
Наименование метода
Интерв
ал,
секунда
Метод для получения информации о существующем SSCC POST
0,5
//reestr/sscc/sscc_check
Создание подписки на получение событий, связанных с выбытием КИЗ POST
0,5
//withdrawal_events/subscribe
Получение списка подписок GET //withdrawal_events/subscriptions
0,5
Изменение подписки на получение событий, связанных с выбытием КИЗ PUT
0,5
//withdrawal_events/subscriptions/{subscription_id}
Получение событий, связанных с выбытием КИЗ GET //withdrawal_events
0,5
Отписка от получения событий, связанных с выбытием КИЗ POST
0,5
//withdrawal_events/unsubscribe
Метод добавления ЭП пользователя для самого себя POST //users/own/add_key
0,5
Метод для получения информации о своих зарегистрированных сертификатах
0,5
пользователя POST //users/own/keys
Метод для поиска списка собственных групп прав по фильтру POST //rights/own/filter
0,5
Метод для получения информации о вариантах собственных прав GET
0,5
//rights/own/about
Метод создания контейнера POST //reestr/containers
0,5
Метод редактирования контейнера PUT //reestr/containers/{container_id}
0,5
Метод скачивания содержимого контейнера GET
0,5
//reestr/containers/{container_id}/download
Метод отображения реестра контейнеров POST //reestr/containers/filter
0,5
Метод передачи контейнера на модерацию POST //reestr/containers/validate
0,5
Метод настройки автоматического присвоения контейнеров к GTIN POST
0,5
//reestr/med_products/assign_container
Метод создания связи между контейнером и серией POST
0,5
//reestr/batches/assign_containe
22
3. Общая информация о методах интерфейса «ИС
"Маркировка". МДЛП»
3.1. Доступ к методам интерфейса «ИС "Маркировка".
МДЛП»
Все методы интерфейса «ИС "Маркировка". МДЛП», кроме Метод для получения кода
аутентификации, Метод для получения ключа сессии и Получение информации об ограничении
размера небольших документов требуют установленного заголовка:
Authorization: token <token_id>
где <token_id> - это ключ сессии, полученный с помощью Метод для получения ключа сессии.
Обратить внимание: Если Участник, к которому относится пользователь, Резидент, то после
процедур аутентификации и авторизации все методы API должны вызываться с использованием
HTTPS протокола. Для взаимодействия по HTTPS используется ГОСТ Р 34.10-2012 сертификат.
3.1.1. Ограничения по использованию методов аутентификации и авторизации
пользователей
Время жизни токена соответствует значению параметру life_time метода Метод для получения
ключа сессии.
ПО Участника должно само отслеживать необходимость получения токена, но получать новый
токен желательно не чаще, чем истечет время жизни предыдущего.
Время простоя составляет 30 минут.
Если Участник не совершал отправок на сервер, в течение указанного времени простоя, то
система потребует получить новый токен.
ПО Участника должно обрабатывать статус ответа методов аутентификации и авторизации, и
получив код ошибки, предпринимать действия по ее анализу перед повторным вызовом.
Например, если при вызове Метод для получения кода аутентификации от сервера пришел ответ
401 "поле user_id введено не верно", то необходимо прервать выполнение и использовать
корректный user_id, а не продолжать бесконтрольно отправлять тот же запрос каждую секунду.
3.2. Получение локализованных сообщений
Методы интерфейса «ИС "Маркировка". МДЛП» возвращают сообщения в соответствии с
установленным у пользователя языком. Проверить настройки можно с помощью Метод для
получения информации о настройках профиля текущего пользователя. По умолчанию
установлен русский язык.
В методах, не требующих авторизованного пользователя, таких как Метод для получения кода
аутентификации, Метод для получения ключа сессии и Получение информации об ограничении
размера небольших документов а также в других методах, когда авторизация невозможна по
неким причинам (например, неверный формат передаваемого токена), для уточнения языка
сообщений необходимо в запросе указать заголовок Accept-Language. На данный момент,
поддерживаются следующие значения для этого заголовка:
23
• ru
• en
24
4. Общие структуры данных, ограничения и
коды завершения операций
4.1. Ограничения на форматы полей данных
Общими ограничениями на форматы полей данных входных запросов являются:
Таблица 2. Ограничения на форматы полей данных
Обозначение
Описание
Формат
Ограничения
Шаблон
SysID
Идентификатор
String
36 символов
Согласно RFC
субъекта
4122: [a-fA-F0-
обращения в «ИС
9]{8}-[a-fA-F0-
"Маркировка".
9]{4}-[a-fA-F0-
МДЛП»
9]{4}-[a-fA-F0-
9]{4}-[a-fA-F0-
9]{12}
UserID
Идентификатор
String
36 символов
Согласно RFC
пользователя в
4122: [a-fA-F0-
«ИС
9]{8}-[a-fA-F0-
"Маркировка".
9]{4}-[a-fA-F0-
МДЛП»
9]{4}-[a-fA-F0-
9]{4}-[a-fA-F0-
9]{12}
BranchID
Идентификатор
String
14 символов
[0-9]{14}
места
деятельности
субъекта
обращения - суб
ъекта учёта в «ИС
"Маркировка".
МДЛП»
GTIN
Идентификацион
String
14 символов
[0-9]{14}
ный номер для
идентификации
товаров
SGTIN
Индивидуальный
String
27 символов
[0-9]{14}[!-&%-
серийный номер
/0-9A-Z_a-z]{13}
вторичной
упаковки
SSCC
Индивидуальный
String
18 символов
[0-9]{18}
серийный номер
третичной/трансп
ортной упаковки
25
Обозначение
Описание
Формат
Ограничения
Шаблон
UUID
Универсальный
String
36 символов
Согласно RFC
уникальный
4122: [a-fA-F0-
идентификатор
9]{8}-[a-fA-F0-
9]{4}-[a-fA-F0-
9]{4}-[a-fA-F0-
9]{4}-[a-fA-F0-
9]{12}
DateTime
Формат даты со
String
Согласно RFC
временем без
3339: ^\d\d\d\d-[0-
указания часового
1]\d-[0-3]\d[t\s][0-
пояса, по
2]\d:[0-5]\d:[0-
умолчанию имеет
5]\d(?:\.\d+)?(?:z|[
часовой пояс
+-]\d\d:\d\d)$
UTC+0
MskDateTime
Формат даты с
String
^\d\d\d\d-[0-1]\d-
московским
[0-3]\d[T\s][0-
временем
2]\d:[0-5]\d:[0-
(UTC+3) без
5]\d(?:\.\d+)?$
указания часового
пояса
Date
Дата в формате
String
10 символов
Согласно RFC
ГГГГ-ММ-ДД
3339: ^\d\d\d\d-
(\d\d)-(\d\d)\s[0-
2]\d:[0-5]\d:[0-
5]\d$
BatchNumber
Номер
String
1-20 символов
\S+(*\S+)*
производственной
серии
TNVED4
Код из ТНВЭД
String
4 символа
[0-9]{4}
ЕАЭС (первые 4
символа кода)
INNFL
Идентификацион
String
12 символов
[0-9]{1}[1-
ный номер
9]{1}|[1-9]{1}[0-
налогоплательщи
9]{1})[0-9]{10}
ка - физического
лица
INNUL
Идентификацион
String
10 символов
[0-9]{1}[1-
ный номер
9]{1}|[1-9]{1}[0-
налогоплательщи
9]{1})[0-9]{8}
ка - юридическо
го лица
ITIN
Идентификацион
String
1-50 символов
.{1,50}
ный номер
налогоплательщи
ка - иностранны
й производитель
26
Обозначение
Описание
Формат
Ограничения
Шаблон
KPP
Код причины
String
9 символов
[0-9]{1}[1-
постановки на
9]{1}|[1-9]{1}[0-
учет
9]{1})[0-9]{7}
DocNumber
Номер документа
String
1-200 символов
.{1,200}
(не более 200
символов)
DocName
Название
String
1-200 символов
.{1,200}
документа (не
более 200
символов)
Price
Цена (в копейках)
Number
\d+
FTSCC
Код таможенного
String
2, 5 или 8
органа
символов
FTSDecision
Код принятого
String
2 символа
решения
таможенного
органа
DeviceID
Идентификатор
String
16 символов
устройства
ACTION_ID
Идентификатор
Number
"0" (ноль), 3
^(0|\d{3}|\d{4}|\d{
операции.
цифры, 4 цифры
5})$
Значение берётся
или 5 цифр
из XSD схемы
4.2. Ограничения постраничного вывода
Все нижеперечисленные методы интерфейса «ИС "Маркировка". МДЛП» с постраничным
выводом информации имеют ограничение по количеству выводимых записей за одну страницу.
В случае запроса большего количества записей вернётся максимально разрешённое записей.
Таблица 3. Ограничения постраничного вывода
№
Наименование метода
Ограни
чение,
шт.
1.
Метод для получения списка входящих документов
100
2.
Метод для получения списка входящих документов из витрины документов
100
3.
Метод для получения списка исходящих документов
100
4.
Метод для получения списка исходящих документов из витрины документов
100
5.
Метод для получения списка групп документов
100
6.
Метод для получения списка стран
100
7.
Метод для получения списка субъектов РФ
100
27
№
Наименование метода
Ограни
чение,
шт.
8.
Метод для поиска информации о местах осуществления деятельности по
100
фильтру
9.
Метод фильтрации реестра мест в зоне таможенного контроля
100
10.
Метод для получения информации из реестра ЕСКЛП
100
11.
Метод для просмотра заявок на регистрацию иностранных контрагентов
100
12.
Метод для получения информации из реестра производимых организацией
100
ЛП
13.
Метод фильтрации по субъектам обращения
100
14.
Метод фильтрации доверенных контрагентов
100
15.
Метод для поиска информации о местах ответственного хранения по
100
фильтру
16.
Метод для получения информации об адресах, на которые возможно
100
зарегистрировать место ответственного хранения
17.
Поиск по реестрам КИЗ
100
18.
Поиск по реестрам КИЗ всех записей со статусом 'Оборот приостановлен'
100
19.
Метод для получения информации о КИЗ в третичной упаковке
100
20.
Метод для поиска УС по фильтру
100
21.
Метод для поиска списка групп прав пользователей по фильтру
100
22.
Метод для получения информации о зарегистрированных сертификатах
100
текущего пользователя
23.
Метод для получения информации о зарегистрированных сертификатах
100
пользователя
24.
Метод для поиска зарегистрированных пользователей по фильтру
100
25.
Фильтрация по реестру регистраторов эмиссии
100
26.
Фильтрация по реестру регистраторов выбытия
100
27.
Метод для поиска по реестру КИЗ записей, ожидающих вывода из оборота
100
по чеку от контрольно-кассовой техники (ККТ)
28.
Метод фильтрации лицензий на производство
100
29.
Метод фильтрации лицензий на фарм. деятельность
100
30.
Метод для поиска публичной информации в реестре производимых ЛП
100
31.
Фильтрация по реестру решений о приостановке КИЗ
100
32.
Получение перечня КИЗ по конкретному решению о приостановке
100
33.
Прослеживание документов по отчёту из СУЗ
100
28
№
Наименование метода
Ограни
чение,
шт.
34.
Метод для поиска по реестру КИЗ записей, ожидающих вывода из оборота
100
через РВ
35.
Фильтрация по реестру решений о вводе лекарственных препаратов в
100
гражданский оборот
36.
Метод для получения сведений по маркированным и ввезенным товарам
100
4.3. Коды завершения операций
Методы сервисов возвращают HTTP коды как REST сервисы в результате завершения операции:
Таблица 4. Коды завершения операций
Значение кода
Расшифровка
Описание
кода
200
OK
Успешное завершение операции
204
NO_CONTENT
Успешное завершение операции. Ответ отсутствует
301
MOVED_PERMA
Перенаправление на URL, который необходимо
NENTLY
использовать для доступа к ресурсу. Адрес нового
месторасположения указывается в поле Location в
заголовке ответа сервера
307
TEMPORARY_R
Аналогично коду 301
EDIRECT
400
BAD_REQUEST
Некорректные данные запроса
401
NOT_AUTHORIZ
Требуется авторизация. См. Доступ к методам
ED
интерфейса «ИС "Маркировка". МДЛП»
403
FORBIDDEN
Недостаточно прав для осуществления операции
404
NOT_FOUND
Запрашиваемый ресурс не найден
429
TOO_MANY_RE
Нарушено ограничение на временной интервал между
QUESTS
вызовами
500
INTERNAL_SER
Внутренняя ошибка системы при выполнении операции
VER_ERROR
503
SERVICE_UNAV
Превышено максимальное время обработки запроса
AILABLE
4.4. Устаревшие методы и поля в методах в документации
Все методы и/или поля в методах, которые в данной документации помечаются словом Устарел,
заменяются на новые методы и/или поля в методах или удаляются. У новых методов могут
отличаться входные, выходные параметры, а также путь доступа к методу. Устаревший метод
и/или поля в методах находятся в API в течение 6 месяцев с момента получения данной отметки.
По истечению данного периода метод и/или поля в методах из API удаляются, остаются только
29
новые (при наличии).
4.5. Установка защищенного соединения к API по TLS
(HTTPS)
Обратить внимание: Если Участник, к которому относится пользователь - Резидент, то после
процедур аутентификации и авторизации все методы API должны вызываться с использованием
HTTPS протокола. Для взаимодействия по HTTPS используется ГОСТ Р 34.10-2012 сертификат.
Перед установкой соединения необходимо выполнить следующие настройки:
1. Общие настройки:
◦ В
операционной
системе
Windows
(7,
10)
добавить
запись
DisableClientExtendedMasterSecret
(dword)
в
реестре
HKLM\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL со значением
1 (т.к. Windows по-умолчанию блокирует подобные соединения).
2. Настройки для продуктового контура:
◦ Адреса API:
▪ для нерезидентов https://nrz.api.mdlp.crpt.ru
▪ для резидентов https://api.mdlp.crpt.ru
◦ Для взаимодействия по HTTPS используется ГОСТ сертификат. Должны быть
установлены оба корневых сертификата. Сертификаты Головного удостоверяющего
центра можно скачать по ссылкам:
◦ Промежуточные сертификаты КриптоПро можно скачать по ссылке:
3. Настройки для тестового контура "Песочница":
◦ Адреса API:
▪ для нерезидентов https://nrz.api.sb.mdlp.crpt.ru
▪ для резидентов https://api.sb.mdlp.crpt.ru
◦ Добавить в хранилище доверенных сертификатов тестовый корневой сертификат от
КриптоПро. Ссылка для загрузки: http://testca.cryptopro.ru/certsrv/certcarc.asp
Используемые протоколы и шифры для соединения (SSL шифры были выбраны с учетом
требований к информационной безопасности по предоставлению публичного API для доступа к
государственной информационной системе):
ssl_protocols: TLSv1 / TLSv1.1 / TLSv1.2 / TLSv1.3
ssl_ciphers: GOST2012-GOST8912-GOST8912
4.6. Формат электронной цифровой подписи
Подпись данных используется в разных разделах API (пример: отправка документов,
30
авторизация для резидентов). Подпись должна поступать в API в формате BASE64 (RFC2045) и
иметь следующие параметры:
Таблица 5. Формат электронной цифровой подписи
Параметр
Значение
Примечание
Стандарт
PKCS7
Тип подписи
Открепленная
Подпись должна содержать
сертификат подписанта
Алгоритм подписи (OID)
1.2.643.7.1.1.3.3
В крипто-про соответствует
GOST_SIGN_2012_512_OID,
GOST3410DH_2012_512,
GOST3410_2012_512.
Также будет поддерживаться
более старый и менее
надежный
алгоритм
1.2.643.7.1.1.3.2
(GOST_SIGN_2012_256_OID,
GOST3410DH_2012_256,
GOST3410_2012_256).
Дайджест (OID)
1.2.643.7.1.1.2.3
В крипто-про соответствует
GOST_DIGEST_2012_512_OI
D, GOST3410DH_2012_512,
GOST3410_2012_512..
Также будет поддерживаться
более старый и менее
надежный
дайджест
1.2.643.7.1.1.2.2
(GOST_DIGEST_2012_256_OI
D, GOST3410DH_2012_256,
GOST3410_2012_256).
Публичный ключ (OID)
1.2.643.7.1.1.1.2
В крипто-про соответствует
GOST_PARAMS_SIG_2012_51
2_KEY_OID,
GOST3410DH_2012_512,
GOST3410_2012_512.
Также будет поддерживаться
более старый и менее
надежная
версия
1.2.643.7.1.1.1.1
(GOST_PARAMS_SIG_2012_2
56_KEY_OID,
GOST3410DH_2012_256,
GOST3410_2012_256).
Крипто провайдер
Любой сертифицированный в
Пример: CryptoPro JCP, VipNet
РФ
CSP и др.
31
4.7. Формат квалифицированного сертификата для ЭЦП
Сертификат для создания ЭЦП должен удовлетворять требованиям по формату, описанным ниже
в документах:
• Федеральный закон от 6 апреля 2011 г. N63-ФЗ "Об электронной подписи": http://ivo.garant.ru/
#/document/12184522/paragraph/455:2
• Приказ ФСБ РФ от 27 декабря 2011 г. N 795 "Об утверждении Требований к форме
квалифицированного сертификата ключа проверки электронной подписи": http://ivo.garant.ru/
#/document/70133464/paragraph/1:5
• Методические рекомендации по составу квалифицированного сертификата ключа проверки
электронной подписи: http://smev.gosuslugi.ru/portal/api/files/get/2832
4.8. Требования к отправке документов, подписываемых
ЭЦП
Документы, которые требуются отправить в API, должны подписываться ЭЦП с использованием
того же сертификата, что был использован при получении авторизационного токена (значение
параметра auth_type - SIGNED_CODE). Авторизационный токен, полученный с помощью логина и
пароля (значение параметра auth_type - PASSWORD), не должен быть использован для отправки в
API подписанных документов.
4.9. Описание идентификаторов, используемых в системе
«ИС "Маркировка". МДЛП»
4.9.1. Идентификатор request_id
Содержит уникальное значение идентификатора запроса на обработку документа в системе.
Является обязательным идентификатором и используется системой для отслеживания процесса
обработки документа. Формат request_id должен соответствовать UUID версии 4 (RFC 4122).
Для достижения уникальности идентификаторов необходимо использовать генератор UUID.
Пример генератора: https://www.uuidgenerator.net/
4.9.2. Идентификатор operation_id
Содержит уникальное значение идентификатора операции, произведённой системой. В случае,
если система не произвела никаких действий (например, в связи с некорректным входным
документом), то данный идентификатор не заполняется.
4.9.3. Идентификатор document_id
Является уникальным идентификатором обрабатываемого или созданного системой документа.
4.9.4. Идентификатор session_ui
Является идентификатором сессии информационного обмена и не управляется системой.
Данный атрибут является необязательным и при наличии используется для объединения всех
документов в рамках одной сессии.
32
4.9.5. Идентификатор original_id
Является идентификатором предыдущей (родительской) сессии информационного обмена.
Данный атрибут также является необязательным и его следует проставлять на основе значения,
полученного из идентификатора session_ui входящего документа. Если session_ui не был
проставлен во входящем документе, то original_id не заполняется.
4.10. Формат ошибки
В случае ошибки обработки запроса формируется ответ, состоящий из HTTP кода об ошибке
(4xx, 5xx) и опционального содержимого по следующему формату:
Таблица 6. Формат ошибки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_descriptio
Текст ошибки
String
1
n
4.11. Список прав пользователей учетной системы
(RightsEnum)
Таблица 7. Список прав пользователей учетной системы (RightsEnum)
Наименование
Тип операции
Расшифровка права
права
UPLOAD_DOCU
Загрузка документа
Позволяет загружать документ
MENT
OUTCOME_LIST
Информация о исходящем
Позволяет получить информацию о исходящих
документе
документах
INCOME_LIST
Информация о входящих
Позволяет получить информацию о входящих
документах
документах
DOWNLOAD_DO
Получение ссылки на
Позволяет по идентификатору документа
CUMENT
документ
получить ссылку на документ.
MANAGE_ACCO
Управление учетными
Позволяет управлять учетными системами,
UNTS
записями
пользователями, группами прав пользователей
VIEW_ACCOUN
Просмотр учетных записей
Позволяет просматривать учетные системы,
TS
пользователей, группы прав пользователей
REESTR_ALL
Доступ к реестрам
Позволяет получить доступ ко всем
справочникам
REESTR_FEDER
Реестр субъектов РФ
Получение информации из реестра субъектов
AL_SUBJECT
Российской Федерации
REESTR_EGRUL
Реестр ЕГРЮЛ
Получение информации из реестра ЕГРЮЛ
REESTR_EGRIP
Реестр ЕГРИП
Получение информации из реестра ЕГРИП
33
Наименование
Тип операции
Расшифровка права
права
REESTR_REFP
Реестр аккредитованных
Получение информации из реестра
филиалов и
аккредитованных филиалов и
представительств
представительств
REESTR_PROD_
Реестр лицензий на
Получение информации из реестра лицензий
LICENSES
производство
на производство
REESTR_PHARM
Реестр лицензий на фарм.
Получение информации из реестра лицензий
_LICENSES
деятельность
на фармацевтическую деятельность
REESTR_ESKLP
Реестр ЕСКЛП
Получение информации из реестра ЕСКЛП
REESTR_FIAS
Реестр ГАР/ФИАС
Получение информации из реестра ГАР/ФИАС
VIEW_BILLING_
Просмотр реестра
Получение данных из реестра приоритетной
PRIORITY_RULE
приоритетной оплаты
оплаты
S (Устарело).
Дата устаревания
2021-05-05.
MANAGE_BILLI
Редактирование реестра
Получение и редактирование данных в реестре
NG_PRIORITY_R
приоритетной оплаты
приоритетной оплаты
ULES (Устарело).
Дата устаревания
2021-05-05.
REESTR_SGTIN
Реестр КИЗ
Получение информации из реестра КИЗ
REESTR_SGTIN_
Реестр КИЗ для биллинга
Получение информации из реестра КИЗ для
BILLING
биллинга
(Устарело). Дата
устаревания 2021-
05-05.
REESTR_OWNE
Реестр КИЗ и реестр
Получение информации из реестра КИЗ и по
D_SSCC_SGTIN
третичных упаковок
третичной упаковке с учетом текущего
владельца
REESTR_MED_P
Реестр производимых ЛП
Получение информации из реестра
RODUCTS
производимых ЛП
MANAGE_TRUS
Реестр доверенных
Позволяет управлять доверенными
TED_PARTNERS
контрагентов
контрагентами
VIEW_TRUSTED
Реестр доверенных
Позволяет просматривать информацию по
_PARTNERS
контрагентов
доверенным контрагентам
MANAGE_BRAN
Реестр мест деятельности
Позволяет добавлять МД
CH
(МД)
MANAGE_SAFE_
Реестр складов/мест
Позволяет добавлять СОХ/МОХ
WAREHOUSE
ответственного хранения
СОХ/МОХ
34
Наименование
Тип операции
Расшифровка права
права
VIEW_REGISTR
Реестр заявок на
Позволяет получать информацию о заявках на
ATION_FOREIG
регистрацию иностранных
регистрацию иностранных контрагентов
N_COUNTERPAR
контрагентов
TY_LOG
MANAGE_FOREI
Управление иностранными
Позволяет регистрировать иностранных
GN_COUNTERP
контрагентами
контрагентов
ARTY
MANAGE_MEM
Управление организацией
Позволяет управлять организацией
BER
REESTR_COUNT
Реестр контрагентов
Получение информации из реестра
ERPARTY
контрагентов
REESTR_REGIST
Реестр РЭ/РВ
Получение информации из реестра
RATION_DEVIC
регистраторов эмиссии/выбытия
ES
MEMBER_PAYM
Финансовая информация
Позволяет взаимодействовать с финансовыми
ENT_INFO
данными участника
REESTR_PAUSE
Реестр решений о
Получение информации из реестра решений о
D_CIRCULATIO
приостановке КИЗ
приостановке КИЗ
N_DECISION
VIEW_SKZKM_R
Прослеживание документов
Позволяет получать информацию по
EPORT
по отчёту из СУЗ
документам по отчёту СУЗ
VIEW_BATCH_G
Просмотр отчета по
Позволяет получать информацию по
RAF
движению ЛП в рамках
распространению производственной серии для
производственной серии
производителя
DELETE_DRAFT
Удаление черновиков
Позволяет удалять черновики
S
BULK_DOCUME
Запуск обработки группы
Позволяет запускать обработку группы
NT
документов
документов
VIEW_LP_IN_CI
Просмотр реестра решений
Позволяет просматривать реестр решений о
RCULATION_DE
о вводе лекарственных
вводе лекарственных препаратов в
CISIONS
препаратов в гражданский
гражданский оборот
оборот
MANAGE_EXPO
Управление асинхронными
Позволяет управлять асинхронными
RT_TASKS
выгрузками
выгрузками
TRACKING_SGTI
Просмотр трекинга SGTIN
Позволяет просматривать раздел "Трекинг
N
SGTIN"
SGTINS_VALIDA
Валидация кода
Позволяет валидировать код маркировки
TION
маркировки
SGTINS_VERIFIC
Верификация кода
Позволяет верифицировать код маркировки с
ATION
маркировки с
криптохвостом
криптохвостом
35
Наименование
Тип операции
Расшифровка права
права
SSCC_CHECK
Получение информации о
Позволяет просматривать информацию о
существующем SSCC
существующем SSCC
REESTR_SGTIN_
Получение перечня
Позволяет просматривать перечень документов
DOCUMENTS
документов по
по идентификатору КИЗ
идентификатору КИЗ
VIEW_BALANCE
Мой виртуальный склад
Позволяет просматривать ЛП на своём балансе
_ON_BP_REPOR
с разбивкой по МД/МОХ
T (Устарел)
VIEW_BATCH_R
Просмотр отчётов по ЛП
Позволяет просматривать отчёты по ЛП
EPORT (
Устарел).
Дата устаревания
2022-12-20
VIEW_BATCHES
Просмотр реестра серий
Позволяет просматривать реестр серий
_REGISTRY
EDIT_BRANCH_
Смена статуса МД
Позволяет изменять статус МД
STATE
EDIT_WAREHOU
Смена статуса МОХ
Позволяет изменять статус МОХ
SE_STATE
VIEW_LP_MOVE
Просмотр отчета по
Позволяет просматривать отчет по движению
MENT_CIRCULA
движению ЛП, введённых в
ЛП, введённых в оборот
TION_REPORT
оборот
VIEW_PRICING_
Просмотр отчёта по ценам
Позволяет просматривать отчет по ценам
REPORT
(Устарело). Дата
устаревания 2022-
12-20
GENERAL_PRICI
Доступ к общему отчету по
Позволяет создавать / скачивать / удалять
NG_REPORT
ценам
выгрузку по общему отчету по ценам
GENERAL_REPO
Доступ к общему отчету по
Позволяет создавать / скачивать / удалять
RT_ON_MOVEM
движению ЛП
выгрузку по общему отчету по движению ЛП
ENT
GENERAL_REPO
Доступ к общему отчету по
Позволяет создавать / скачивать / удалять
RT_ON_REMAIN
остаткам ЛП
выгрузку по общему отчету по остаткам ЛП
ING_ITEMS
GENERAL_REPO
Доступ к общему отчету по
Позволяет создавать / скачивать / удалять
RT_ON_DISPOSA
выбытию ЛП
выгрузку по общему отчету по выбытию ЛП
L
VIRTUAL_WARE
Доступ к отчёту "Мой
Позволяет создавать / скачивать / удалять
HOUSE_REPORT
виртуальный склад
выгрузку по отчету
(новый)"
36
4.12. Список прав и методов, доступных пользователям с
обезличенной УКЭП
Для подключения с использованием одной обезличенной УКЭП есть
ВАЖНО
ограничение на максимальное количество сессий - 200
Таблица 8. Список прав и методов, доступных пользователям с обезличенной УКЭП
Название права
Описание права
Доступные методы и типы задач
INCOME_LIST
Просмотр
Получение списка входящих документов POST
входящих
//documents/income;
документов
Получение списка входящих документов из витрины
документов POST //documents/showcase/income;
Передача информации о прочтении документа POST
//documents/income/mark_read
OUTCOME_LIST
Просмотр
Получение списка исходящих документов POST
исходящих
//documents/outcome;
документов
Получение списка исходящих документов из витрины
документов POST //documents/showcase/outcome
UPLOAD_DOCU
Загрузка
Отправка документа POST //documents/send;
MENT
документов
Отправка документа большого объема POST
//documents/send_large;
Загрузка документа большого объема PUT
//webdav/upload/{doc_id}/{doc_id};
Завершение отправки документа POST
//documents/send_finished;
Получение информации о группе документов GET
//documents/bulk/{bulk_id};
Получение информации по имеющимся группам
документов POST //documents/bulk/filter;
Отмена отправки документа POST //documents/cancel;
Скачивание документа по идентификатору GET
//webdav/upload/{doc_id}/{doc_id}
DOWNLOAD_DO
Скачивание
Получение метаданных документа GET
CUMENT
документов
//documents/{docId};
Получение документа по идентификатору GET
//documents/download/{docId};
Получение списка документов по идентификатору
запроса GET //documents/request/{request_id};
Получение квитанции по номеру исходящего документа
GET //documents/{docId}/ticket;
Получение электронной подписи исходящего документа
GET //documents/{docId}/signature;
Скачивание документа по идентификатору GET
//webdav/upload/{doc_id}/{doc_id}
VIEW_SKZKM_R
Прослеживание
Прослеживание документов по отчёту из СУЗ POST
EPORT
документов по
//documents/skzkm-traces/filter
отчёту из СУЗ
37
Название права
Описание права
Доступные методы и типы задач
BULK_DOCUME
Операции с
Запуск обработки группы документов POST
NT
группами
//documents/bulk;
документов
Проверка возможности запуска группы документов
POST //documents/bulk/check
VIEW_ACCOUN
Просмотр
Метод для получения информации о
TS
учетных записей
зарегистрированных сертификатах пользователя POST
пользователей
//users/{user_id}/keys;
Метод для получения информации об УС GET
//account_systems/{account_system_id};
Метод для получения информации о существующих
правах GET //rights/about;
Метод для получения информации о группе прав
пользователей GET //rights/{group_id};
Метод для поиска списка групп прав пользователей по
фильтру POST //rights/filter;
Метод для поиска зарегистрированных пользователей по
фильтру POST //users/filter;
Метод для поиска УС по фильтру POST
//account_systems/filter
38
Название права
Описание права
Доступные методы и типы задач
REESTR_ALL
Просмотр общей
Выгрузка иерархии по SGTIN (sscc_hierarchy);
информации по
Выгрузка общедоступной информации по SGTIN
участнику из
(public_sgtins);
реестров
Выгрузка общедоступной информации по SGTIN из
архива (public_sgtins_archive);
Получение данных записи ЕГРЮЛ GET //reestr/egrul;
Получение данных записи ЕГРИП GET //reestr/egrip;
Получение записи реестра РАФП GET //reestr/rafp;
Получение текстового адреса по идентификаторам
ГАР/ФИАС POST //reestr/fias/resolve;
Получение информации о лицензиях на производство
GET //reestr/prod_licenses;
Метод фильтрации лицензий на производство POST
//reestr/prod_licenses;
Получение информации о лицензиях на фарм.
деятельность GET //reestr/pharm_licenses;
Метод фильтрации лицензий на фарм. деятельность
POST //reestr/pharm_licenses;
Метод для получения информации о всех местах
осуществления деятельности и местах ответственного
хранения участника GET //reestr/address/all;
Фильтрация по реестру ЕСКЛП POST //reestr/esklp/filter;
Метод для поиска информации о местах осуществления
деятельности по фильтру POST //reestr/branches/filter;
Получение перечня мест осуществления деятельности в
системе POST //reestr/branches/public/filter;
Получение информации о конкретном месте
осуществления деятельности GET
//reestr/branches/{branch_id};
Метод для редактирования параметров МД для аптек
PUT //reestr/branches/info;
Метод для поиска информации о местах ответственного
хранения по фильтру POST //reestr/warehouses/filter;
Получение перечня мест ответственного хранения в
системе POST //reestr/warehouses/public/filter;
Получение информации о конкретном месте
ответственного хранения GET
//reestr/warehouses/{warehouse_id};
39
Название права
Описание права
Доступные методы и типы задач
Метод получения информации об адресах искомого
участника для регистрации мест ответственного
хранения или отправки документов POST
//reestr/warehouses/available_safe_warehouses_addresses;
Метод поиска по реестрам КИЗ POST //reestr/sgtin/filter;
Метод поиска по реестрам КИЗ по списку значений
POST //reestr/sgtin/sgtins-by-list;
Метод поиска по общедоступным реестрам КИЗ по
списку значений POST //reestr/sgtin/public/sgtins-by-list;
Метод поиска по общедоступному реестру КИЗ в
архивном хранилище по списку значений POST
//reestr/sgtin/public/archive/sgtins-by-list;
Метод для получения из реестров КИЗ детальной
информации о КИЗ и связанным с ним ЛП GET
//reestr/sgtin/{sgtin};
Метод для получения детальной информации о КИЗ в
архивном хранилище и связанным с ним ЛП GET
//reestr/sgtin/archive/{sgtin};
Метод для получения перечня документов по
идентификатору КИЗ GET //reestr/sgtin/documents;
Метод для получения перечня документов по
идентификатору КИЗ из архивного хранилища GET
//reestr/sgtin/archive/documents;
Метод поиска по реестрам КИЗ всех записей со статусом
'Оборот приостановлен' POST //reestr/sgtin/on_hold;
Метод для поиска по реестру КИЗ записей для вывода из
оборота по чеку от контрольно-кассовой техники (ККТ)
POST //reestr/sgtin/kkt/awaiting-withdrawal/filter;
Метод для поиска по реестру КИЗ записей для вывода из
оборота через РВ POST //reestr/sgtin/device/awaiting-
withdrawal/filter;
Метод для получения сведений по маркированным и
ввезенным товарам POST //reestr/marking_lp;
Метод для получения информации об иерархии
вложенности третичной упаковки GET
//reestr/sscc/{sscc}/hierarchy;
Метод для получения информации о КИЗ в третичной
упаковке POST //reestr/sscc/{sscc}/sgtins;
40
Название права
Описание права
Доступные методы и типы задач
Метод для получения информации о полной иерархии
вложенности третичной упаковки GET
//reestr/sscc/{sscc}/full-hierarchy;
Метод для получения информации о полной иерархии
вложенности третичной упаковки для нескольких SSCC
GET //reestr/sscc/full-hierarchy;
Метод для получения информации из реестра
производимых организацией ЛП POST
//reestr/med_products/current;
Метод для получения детальной информации о
производимом организацией ЛП GET
//reestr/med_products/{gtin};
Метод для поиска публичной информации в реестре
производимых ЛП POST
//reestr/med_products/public/filter;
Метод для получения публичной информации о
производимом ЛП GET
//reestr/med_products/public/{gtin};
Метод для просмотра заявок на регистрацию
иностранных контрагентов POST
//reestr/foreign_counterparty/filter;
Метод фильтрации по субъектам обращения POST
//reestr_partners/filter;
Фильтрация по реестру регистраторов эмиссии POST
//reestr/registration-devices/emission/filter;
Фильтрация по реестру регистраторов выбытия POST
//reestr/registration-devices/withdrawal/filter;
Фильтрация по реестру решений о приостановке КИЗ
POST //reestr/paused-circulation-decisions/filter;
Получение перечня КИЗ по конкретному решению о
приостановке POST //reestr/paused-circulation-
decisions/{halt_id}/sgtins/filter;
Фильтрация по реестру решений о вводе лекарственных
препаратов в гражданский оборот POST //reestr/lp-in-
circulation-decisions/filter;
Получение сводной информации распределения ЛП
(временно приостановлен) POST //reestr/batches/short-
distribution;
Фильтрация по реестру деклараций (импортные ЛП)
POST //reestr/declarations/filter;
Фильтрация по реестру партий, ввозимых из ЕАЭС
POST //reestr/consignments/filter
REESTR_PHARM
Просмотр
Получение информации о лицензиях на фарм.
_LICENSES
информации о
деятельность GET //reestr/pharm_licenses;
фармацевтическо
Метод фильтрации лицензий на фарм. деятельность
й лицензии
POST //reestr/pharm_licenses
41
Название права
Описание права
Доступные методы и типы задач
REESTR_PROD_
Просмотр
Получение информации о лицензиях на производство
LICENSES
информации о
GET //reestr/prod_licenses;
производственной
Метод фильтрации лицензий на производство POST
лицензии
//reestr/prod_licenses
REESTR_EGRIP
Просмотр
Получение данных записи ЕГРИП GET //reestr/egrip
информации по
участнику из
ЕГРИП
REESTR_EGRUL
Просмотр
Получение данных записи ЕГРЮЛ GET //reestr/egrul
информации по
участнику из
ЕГРЮЛ
REESTR_FIAS
Просмотр реестра
Получение текстового адреса по идентификаторам
ГАР/ФИАС
ГАР/ФИАС POST //reestr/fias/resolve
REESTR_MED_P
Просмотр реестра
Метод для получения информации из реестра
RODUCTS
производимых
производимых организацией ЛП POST
ЛП
//reestr/med_products/current;
Метод для получения детальной информации о
производимом организацией ЛП GET
//reestr/med_products/{gtin};
Метод для поиска публичной информации в реестре
производимых ЛП POST
//reestr/med_products/public/filter;
Метод для получения публичной информации о
производимом ЛП GET
//reestr/med_products/public/{gtin}
REESTR_REFP
Просмотр
Получение записи реестра РАФП GET //reestr/rafp
информации об
аккредитованных
филиалах и
представительств
ах
42
Название права
Описание права
Доступные методы и типы задач
REESTR_FEDER
Просмотр
Метод для получения информации о всех местах
AL_SUBJECT
информации
осуществления деятельности и местах ответственного
МД/МОХ
хранения участника GET //reestr/address/all;
Метод для поиска информации о местах осуществления
деятельности по фильтру POST //reestr/branches/filter;
Получение перечня мест осуществления деятельности в
системе POST //reestr/branches/public/filter;
Получение информации о конкретном месте
осуществления деятельности GET
//reestr/branches/{branch_id};
Метод для редактирования параметров МД для аптек
PUT //reestr/branches/info;
Метод для поиска информации о местах ответственного
хранения по фильтру POST //reestr/warehouses/filter;
Получение перечня мест ответственного хранения в
системе POST //reestr/warehouses/public/filter;
Получение информации о конкретном месте
ответственного хранения GET
//reestr/warehouses/{warehouse_id};
Метод получения информации об адресах искомого
участника для регистрации мест ответственного
хранения или отправки документов POST
//reestr/warehouses/available_safe_warehouses_addresses
REESTR_REGIST
Получение
Фильтрация по реестру регистраторов эмиссии POST
RATION_DEVIC
информации из
//reestr/registration-devices/emission/filter;
ES
реестра устройств
Фильтрация по реестру регистраторов выбытия POST
регистрации
//reestr/registration-devices/withdrawal/filter
REESTR_PAUSE
Просмотр реестра
Фильтрация по реестру решений о приостановке КИЗ
D_CIRCULATIO
решений о
POST //reestr/paused-circulation-decisions/filter;
N_DECISION
приостановке ЛП
Получение перечня КИЗ по конкретному решению о
приостановке POST //reestr/paused-circulation-
decisions/{halt_id}/sgtins/filter
VIEW_LP_IN_CI
Получение
Фильтрация по реестру решений о вводе лекарственных
RCULATION_DE
информации из
препаратов в гражданский оборот POST //reestr/lp-in-
CISIONS
реестра решений
circulation-decisions/filter;
о вводе серии в
Фильтрация по реестру деклараций (импортные ЛП)
гражданский
POST //reestr/declarations/filter;
оборот
Фильтрация по реестру партий, ввозимых из ЕАЭС
POST //reestr/consignments/filter
VIEW_BATCHES
Просмотр реестра
Выгрузка из реестра серий (batches_registry)
_REGISTRY
серий
REESTR_COUNT
Просмотр реестра
Метод фильтрации по субъектам обращения POST
ERPARTY
контрагентов
//reestr_partners/filter
VIEW_TRUSTED
Просмотр
Метод фильтрации доверенных контрагентов POST
_PARTNERS
доверенных
//reestr/trusted_partners/filter;
контрагентов
Метод проверки доверенных контрагентов GET
//reestr/trusted_partners/check/{inn}
43
Название права
Описание права
Доступные методы и типы задач
REESTR_ESKLP
Просмотр
Фильтрация по реестру ЕСКЛП POST //reestr/esklp/filter
информации из
ЕСКЛП
VIEW_BALANCE
Мой виртуальный
Выгрузка отчёта "Мой виртуальный склад" (Устарел)
_ON_BP_REPOR
склад
(remaining_medicines_branches)
T (Устарел)
GENERAL_PRICI
Общий отчет по
Метод создания нового задания на выгрузку POST
NG_REPORT
ценам
//data/export/tasks;
Метод получения выгрузки GET
//data/export/results/{result_id}/file;
Метод удаления файла выгрузки DELETE
//data/export/results/{result_id};
Общий отчёт по ценам (GENERAL_PRICING_REPORT)
GENERAL_REPO
Общий отчет по
Метод создания нового задания на выгрузку POST
RT_ON_DISPOSA
выбытию
//data/export/tasks;
L
Метод получения выгрузки GET
//data/export/results/{result_id}/file;
Метод удаления файла выгрузки DELETE
//data/export/results/{result_id};
Общий отчёт по выбытию ЛП
(GENERAL_REPORT_ON_DISPOSAL)
GENERAL_REPO
Общий отчет по
Метод создания нового задания на выгрузку POST
RT_ON_MOVEM
движению
//data/export/tasks;
ENT
Метод получения выгрузки GET
//data/export/results/{result_id}/file;
Метод удаления файла выгрузки DELETE
//data/export/results/{result_id};
Общий отчёт по движению ЛП
(GENERAL_REPORT_ON_MOVEMENT)
GENERAL_REPO
Общий отчет по
Метод создания нового задания на выгрузку POST
RT_ON_REMAIN
остаткам
//data/export/tasks;
ING_ITEMS
Метод получения выгрузки GET
//data/export/results/{result_id}/file;
Метод удаления файла выгрузки DELETE
//data/export/results/{result_id};
Общий отчёт по остаткам ЛП
(GENERAL_REPORT_ON_REMAINING_ITEMS)
44
Название права
Описание права
Доступные методы и типы задач
MANAGE_EXPO
Управление
Создание задачи POST //export/tasks/{task_type};
RT_TASKS
асинхронными
Просмотр информации о задаче пользователя GET
выгрузками
//export/tasks/{task_id};
Просмотр списка задач пользователя POST
//export/tasks/filter;
Получение результата задачи GET
//export/tasks/{task_id}/result;
Отмена задачи POST //export/tasks/{task_id}/cancel;
Удаление задачи DELETE //export/tasks/{task_id};
Просмотр списка установленных ограничений на
количество задач GET //export/tasks/settings;
Выгрузка списка успешно обработанных SGTIN по id
исходного XML-документа (sgtins_by_doc_id)
SGTINS_VALIDA
Проверка кодов
Метод валидации кода маркировки POST //sgtin/validate
TION
маркировки
SGTINS_VERIFIC
Проверка кодов
Метод верификации кода маркировки и криптохвоста
ATION
маркировки и
POST //sgtin/verification
криптохвостов
SSCC_CHECK
Получение
Метод для получения информации о существующем
информации о
SSCC POST //reestr/sscc/sscc_check;
существующем
Выгрузка информации о количестве SGTIN и их сериях в
SSCC
SSCC (number_sgtins_in_batches)
REESTR_OWNE
Получение
Метод поиска по реестрам КИЗ по списку значений
D_SSCC_SGTIN
информации из
POST //reestr/sgtin/sgtins-by-list;
реестра КИЗ и по
Метод для получения информации об иерархии
третичной
вложенности третичной упаковки GET
упаковке с учетом
//reestr/sscc/{sscc}/hierarchy;
текущего
Метод для получения информации о КИЗ в третичной
владельца
упаковке POST //reestr/sscc/{sscc}/sgtins;
Метод для получения информации о полной иерархии
вложенности третичной упаковки GET
//reestr/sscc/{sscc}/full-hierarchy;
Метод для получения информации о полной иерархии
вложенности третичной упаковки для нескольких SSCC
GET //reestr/sscc/full-hierarchy;
Выгрузка иерархии по SGTIN (sscc_hierarchy)
VIRTUAL_WARE
Мой виртуальный
Метод создания нового задания на выгрузку POST
HOUSE_REPORT
склад (новый)
//data/export/tasks;
Метод получения выгрузки GET
//data/export/results/{result_id}/file;
Метод удаления файла выгрузки DELETE
//data/export/results/{result_id};
Мой виртуальный склад (новый)
(VIRTUAL_WAREHOUSE_REPORT)
45
4.13. Список статусов документа (DocStatusEnum)
Таблица 9. Список статусов документа
Наименование статуса
Тип операции
Расшифровка статуса
UPLOADING_DOCUMENT
Загрузка документа
Документ загружается
IN_BULK
Документ включен в группу
Документ включен в группу и
ожидает начала обработки на
трансформаторе
PROCESSING_DOCUMENT
Первичная обработка
Документ принят и
документа
обрабатывается
трансформатором
CORE_PROCESSING_DOCU
Обработка документа
Документ обработан
MENT
системой
трансформатором и принят на
обработку системой
CORE_PROCESSED_DOCUM
Подготовка ответа
Документ обработан системой
ENT
и трансформатор
подготавливает ответ
PROCESSED_DOCUMENT
Документ обработан, ответ
Документ обработан
подготовлен
трансформатором и готов для
загрузки
FAILED
Ошибка обработки
Произошла ошибка во время
обработки документа
FAILED_RESULT_READY
Ошибка обработки, ответ
Произошла ошибка во время
подготовлен
обработки документа.
Квитанция для документа с
информацией о причине сбоя
сформирована и может быть
получена по request_id
4.14. Список типов групп прав (GroupTypeEnum)
Таблица 10. Список типов групп прав
Номер типа
Тип группы прав
Примечание
0
Пользовательская группа прав
Создаётся пользователем.
Только над группами прав с
этим типом разрешены
операции модификации
(удаление, редактирование,
добавление/удаление
пользователей).
46
Номер типа
Тип группы прав
Примечание
1
Системная группа прав
Создается автоматически при
регистрации участника. В нее
входят пользователи,
состоящие в реестрах
ЕГРИП/ЕГРЮЛ/РАФП
(администраторы).
2
Группа прав "Производитель"
Создается автоматически у
представительства,
иностранного участника или
участника при наличии
производственной лицензии.
Позволяет работать с
заявлениями и анкетами на
устройства регистрации
эмиссии, а также с реестрами
биллинга.
3
Группа прав "Медицинская
Создается автоматически у
деятельность"
участника при наличии
медицинской лицензии.
Позволяет работать с
заявлениями и анкетами на
устройства регистрации
выбытия.
4
Группа прав "Заказчик КМ"
Создается по заявке. Позволяет
работать с заявлениями на
коды маркировки.
5
Группа прав
Создается автоматически у
"Фармацевтическая
участника при наличии
организация"
фармацевтической лицензии.
Позволяет работать с
заявлениями и анкетами на
устройства регистрации
выбытия.
6
Группа прав "Держатель
Создается по заявке. Позволяет
регистрационного
работать с заявлениями и
удостоверения"
анкетами на устройства
регистрации эмиссии, а также
с реестрами биллинга.
7
Группа прав "Организация с
Создается автоматически у
лицензией на наркотическую
участника при наличии
деятельность"
лицензией на наркотическую
деятельность. Позволяет
работать с заявлениями и
анкетами на устройства
регистрации выбытия.
47
4.15. Список типов аутентификации (AuthType)
Таблица 11. Список типов аутентификации
Наименование типа
Расшифровка статуса
PASSWORD
Аутентификация с помощью пароля
SIGNED_CODE
Аутентификация с помощью подписанного
одноразового кода
4.16. Список статусов пользователя (UserStatus)
Таблица 12. Список статусов пользователя
Статус
Описание
ACTIVE
Активен
BLOCKED
Заблокирован
DELETED
Удален
4.17. Список причин смены статуса пользователя
(UserStatusReason)
Таблица 13. Список причин смены статуса пользователя
Причина
Описание
MANUAL_BLOCK
Заблокирован вручную
TEMPORARY_BLOCK
Временно заблокирован по причине
превышения количества неверных попыток
входа
INACTIVE_BLOCK
Заблокирован по причине длительного
бездействия
PASSWORD_EXPIRED
Заблокирован по причине истечения срока
действия пароля
4.18. Список типов задач на получение аналитических
данных (TaskType)
Таблица 14. Список типов задач на получение аналитических данных
Наименование типа
Описание
detail_batch_movements (Временно
Выгрузка детализированной информации по
приостановлен)
движению ЛП
sscc_hierarchy
Выгрузка иерархии по SGTIN
remaining_medicines_branches (Устарел)
Выгрузка отчёта "Мой виртуальный склад"
public_sgtins
Выгрузка общедоступной информации по
SGTIN
48
Наименование типа
Описание
number_sgtins_in_batches
Выгрузка информации о количестве SGTIN и
их сериях в SSCC
batches_registry
Выгрузка из реестра серий
public_sgtins_archive
Выгрузка общедоступной информации по
SGTIN из архива
sgtins_by_doc_id
Выгрузка списка успешно обработанных
SGTIN по id исходного XML-документа
4.19. Список типов задач для фильтрации аналитических
данных (TaskType)
Таблица 15. Список типов задач для фильтрации аналитических данных
Наименование типа
Описание
DETAIL_BATCH_MOVEMENTS (Временно
Выгрузка детализированной информации по
приостановлен)
движению ЛП
SSCC_HIERARCHY
Выгрузка иерархии по SGTIN
REMAINING_MEDICINES_BRANCHES
Выгрузка отчёта "Мой виртуальный склад"
(Устарел)
PUBLIC_SGTINS
Выгрузка общедоступной информации по
SGTIN
NUMBER_SGTINS_IN_BATCHES
Выгрузка информации о количестве SGTIN и
их сериях в SSCC
BATCHES_REGISTRY
Выгрузка из реестра серий
PUBLIC_SGTINS_ARCHIVE
Выгрузка общедоступной информации по
SGTIN из архива
SGTINS_BY_DOC_ID
Выгрузка списка успешно обработанных
SGTIN по id исходного XML-документа
4.20. Список статусов обработки задачи на получение
аналитических данных (TaskStatus)
Таблица 16. Список статусов задачи на получение аналитических данных
Статус
Описание
ACCEPTED
Задача принята в очередь на обработку
IN_PROGRESS
Задача находится в обработке
FAILED
Обработка завершилась с ошибкой
COMPLETED
Обработка завершилась успешно
49
содержание .. 1 2 ..
////////////////////////////////////////// |
||
|
|
|