Главная Книги - Разные Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов (версия 4.65.0)
поиск по сайту правообладателям
|
|
содержание .. 2 3 4 5 ..
"start_from": 0,
"count": 100
}
Получение результата:
{
"total": 1,
"certs": [
{
"public_cert_serial_number": "323385993632669155411514647635072627598",
"public_cert_thumbprint": "E58510F9623B5352D114A3D58D07F9C2427266B6",
"valid_from": "17-03-2017 07:36:00",
"valid_to": "17-06-2018 07:36:00",
"org_name": "АО \"ТАБЛЕТКИ\"",
"owner": "АО \"ТАБЛЕТКИ\"",
"owner_fio": "ИВАНОВ ИВАН ИВАНОВИЧ",
"issuer_name": "УЦ1 ЗАО \"ПФ \"СКБ КОНТУР\""
}
]
}
6.1.10. Метод для получения информации о зарегистрированных сертификатах
пользователя
Endpoint: POST <endpoint>/<version>/users/{user_id}/keys
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
Параметр пути
идентификатор
(path param)
пользователя
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
150
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтрация по
Object
UserCertsFilter
0
параметрам
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
certs
Сертификаты
Array of
UserCert
1
(ключи)
Objects
пользователя
total
Общее
Number
1
количество
записей по
запросу
Формат объекта UserCert описан выше.
Пример использования метода
Запрос:
POST api/v1/users/5b5540c4-fbb0-4ad7-a038-c8222affab3f/keys HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"start_from": 0,
"count": 100
}
Получение результата:
{
"total": 1,
"certs": [
{
"public_cert_serial_number": "323385993632669155411514647635072627598",
"public_cert_thumbprint": "E58510F9623B5352D114A3D58D07F9C2427266B6",
151
"valid_from": "17-03-2017 07:36:00",
"valid_to": "17-06-2018 07:36:00",
"org_name": "АО \"ТАБЛЕТКИ\"",
"owner": "АО \"ТАБЛЕТКИ\"",
"owner_fio": "ИВАНОВ ИВАН ИВАНОВИЧ",
"issuer_name": "УЦ1 ЗАО \"ПФ \"СКБ КОНТУР\""
}
]
}
6.1.11. Метод для получения информации об УС
Endpoint: GET <endpoint>/<version>/account_systems/{account_system_id}
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
account_system
Уникальный
String
UUID
1
Параметр пути
_id
идентификатор
(path param)
УС
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
account_system
УС
Object
AccountSystem
1
Пример использования метода
Запрос:
GET api/v1/account_systems/7baf5610-554f-4887-8f41-1fc7f07449d5 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
152
{
"account_system": {
"account_system_id": "7baf5610-554f-4887-8f41-1fc7f07449d5",
"name": "Тестовая УС для компании ООО Медицина",
"client_id": "7df0d06f-6510-44fe-a378-76cb53e2605f"
}
}
6.2. Аутентификация и авторизация пользователей
6.2.1. Метод для получения кода аутентификации
Endpoint: POST <endpoint>/<version>/auth
Необходимые права доступа: отсутствуют
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
client_id
Идентификато
String
UUID
1
р клиента
client_secret
Секретный
String
1
ключ
user_id
Уникальный
String
1
Если
идентификатор
идентификаци
пользователя
я идет для
резидента, то
это поле
заполняется
идентификато
ром
сертификата*,
если для
нерезидента,
то - email.
153
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
auth_type
Тип
String
AuthType
1
• SIGNED_C
аутентификаци
ODE
-
и
ЭЦП
(резиденты
)
• PASSWOR
D - пароль
(нерезиден
ты)
* - Идентификатор сертификата - это серийный номер сертификата в десятичной форме либо
отпечаток сертификата (требуемый алгоритм хэширования - SHA1). Так же допускается
использование идентификатора пользователя user_id, который возвращается в выходных
данных Метод для регистрации пользователей (для резидентов страны).
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
code
Код для
String
UUID
1
аутентификаци
и
Пример использования метода с логином
Запрос:
POST api/v1/auth HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
{
"client_id": "7df0d06f-6510-44fe-a378-76cb53e2605f",
"client_secret": "49781b3a-19d5-4ad7-b1b6-abb57e598d41",
"user_id": "user",
"auth_type": "PASSWORD"
}
Получение результата:
154
{
"code": "acf5c2c8-6d2c-41e5-ae75-6f98d3123d36"
}
Пример использования метода с подписью
Запрос:
POST api/v1/auth HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
{
"client_id": "7df0d06f-6510-44fe-a378-76cb53e2605f",
"client_secret": "49781b3a-19d5-4ad7-b1b6-abb57e598d41",
"user_id": "1865725612",
"auth_type": "SIGNED_CODE"
}
Получение результата:
{
"code": "d41c2054-8c95-4367-adec-41d16d20888c"
}
6.2.2. Метод для получения ключа сессии
Endpoint: POST <endpoint>/<version>/token
Необходимые права доступа: аутентифицированный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
code
Код для
String
UUID
1
аутентификаци
и
155
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
signature
Открепленная
String
BASE64
0
Обязательный
подпись кода
для
типа
для
SIGNED_CODE
аутентификаци
См. Формат
и
электронной
цифровой
подписи
password
Пароль
String
0
Обязательный
пользователя
для
типа
PASSWORD
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
token
Ключ сессии
String
UUID
1
УС
life_time
Время жизни
Number
1
В минутах
ключа сессии
Пример использования метода с логином
Запрос:
POST api/v1/token HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
{
"code": "acf5c2c8-6d2c-41e5-ae75-6f98d3123d36",
"password": "password123"
}
Получение результата:
{
"token": "64193f26-8564-49c1-b1f4-4d84880ebaa7",
"life_time": 30
156
}
Пример использования метода с подписью
Запрос:
POST api/v1/token HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
{
"code": "d41c2054-8c95-4367-adec-41d16d20888c",
"signature":
"MIAGCSqGSIb3DQEHAqCAMIACAQExDDAKBgYqhQMCAgkFADCABgkqhkiG9w0BBwEAAKCAMIIBjjCCAT2gAwIBA
gIEWWJzHzAIBgYqhQMCAgMwMTELMAkGA1UEBhMCUlUxEjAQBgNVBAoMCUNyeXB0b1BybzEOMAwGA1UEAwwFQWx
pYXMwHhcNMTcxMTEzMTczMjI4WhcNMTgxMTEzMTczMjI4WjAxMQswCQYDVQQGEwJSVTESMBAGA1UECgwJQ3J5c
HRvUHJvMQ4wDAYDVQQDDAVBbGlhczBjMBwGBiqFAwICEzASBgcqhQMCAiQABgcqhQMCAh4BA0MABEAIWARzAiI
81k4i4Gz8EC7Ic01653JX5PCUfvgCBTpLduYtbTwLOwmGFcZzw9bwsxQpALqhcdRHxtx1UEeNKJuMozswOTAOB
gNVHQ8BAf8EBAMCA+gwEwYDVR0lBAwwCgYIKwYBBQUHAwIwEgYDVR0TAQH/BAgwBgEB/wIBBTAIBgYqhQMCAgM
DQQBL9CrIk0EgnMVr1J5dKbfXVFrhJxGxztFkTdmGkGJ6gHywB5Y9KpP67pv7I2bP1m1ej9hu+C17GSJrWgMgq
+UZAAAxggEFMIIBAQIBATA5MDExCzAJBgNVBAYTAlJVMRIwEAYDVQQKDAlDcnlwdG9Qcm8xDjAMBgNVBAMMBUF
saWFzAgRZYnMfMAoGBiqFAwICCQUAoGkwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxD
xcNMTcxMTMwMDkyMTU5WjAvBgkqhkiG9w0BCQQxIgQg+vo77XxU6eHIpoZxOwIk+gWY+JSv9lfa1TgOM/UW8ao
wCAYGKoUDAgIDBECJhWsLOQ1Wn4KntnGNL8KNZSpbpJ35E8NjyEio+Im5dLiLoqZotxGFlWMmYvBaPy8FHcAsT
qaEEJna7+CecOi/AAAAAAAA"
}
Получение результата:
{
"token": "cb33fd3a-1104-48de-88b2-1a64434f1eb5",
"life_time": 30
}
6.2.3. Метод для выхода из системы
Endpoint: GET <endpoint>/<version>/auth/logout
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
157
ответа.
Пример использования метода
Запрос:
GET api/v1/auth/logout HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
HTTP код 200 OK
6.3. Удаление учетных систем и пользователей учетной
системы
6.3.1. Метод для удаления пользователей учетной системы
Endpoint: DELETE <endpoint>/<version>/users/{user_id}
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
Параметр пути
идентификатор
(path param)
пользователя
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
DELETE api/v1/users/5b5540c4-fbb0-4ad7-a038-c8222affab3f HTTP/1.1
Host: api.sb.mdlp.crpt.ru
158
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
HTTP код 200 OK
6.3.2. Метод для удаления учетной системы
Endpoint: DELETE <endpoint>/<version>/account_systems/{account_system_id}
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
account_system
Идентификато
String
UUID
1
Параметр пути
_id
р учетной
(path param)
системы
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Запрос:
DELETE api/v1/account_systems/7baf5610-554f-4887-8f41-1fc7f07449d5 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
HTTP код 200 OK
6.4. Изменение ЭП пользователя (для резидентов)
6.4.1. Метод для добавления ЭП пользователя (для резидентов)
Endpoint: POST <endpoint>/<version>/users/{user_id}/add_key
Необходимые права доступа: MANAGE_ACCOUNTS
159
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
Параметр пути
идентификатор
(path param)
пользователя
public_cert
Публичный
String
BASE64
1
Необходимо
сертификат
использовать
пользователя
публичный
сертификат, а
не публичный
ключ
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
POST api/v1/users/5b5540c4-fbb0-4ad7-a038-c8222affab3f/add_key HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"public_cert":
"MIIBjjCCAT2gAwIBAgIEWWJzHzAIBgYqhQMCAgMwMTELMAkGA1UEBhMCUlUxEjAQBgNVBAoMCUNyeXB0b1Byb
zEOMAwGA1UEAwwFQWxpYXMwHhcNMTcxMTEzMTczMjI4WhcNMTgxMTEzMTczMjI4WjAxMQswCQYDVQQGEwJSVTE
SMBAGA1UECgwJQ3J5cHRvUHJvMQ4wDAYDVQQDDAVBbGlhczBjMBwGBiqFAwICEzASBgcqhQMCAiQABgcqhQMCA
h4BA0MABEAIWARzAiI81k4i4Gz8EC7Ic01653JX5PCUfvgCBTpLduYtbTwLOwmGFcZzw9bwsxQpALqhcdRHxtx
1UEeNKJuMozswOTAOBgNVHQ8BAf8EBAMCA+gwEwYDVR0lBAwwCgYIKwYBBQUHAwIwEgYDVR0TAQH/BAgwBgEB/
wIBBTAIBgYqhQMCAgMDQQBL9CrIk0EgnMVr1J5dKbfXVFrhJxGxztFkTdmGkGJ6gHywB5Y9KpP67pv7I2bP1m1
ej9hu+C17GSJrWgMgq+UZ"
}
Получение результата:
HTTP код 200 OK
160
6.4.2. Метод для удаления ЭП пользователя (для резидентов)
Endpoint: DELETE <endpoint>/<version>/users/{user_id}/delete_key
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
Параметр пути
идентификатор
(path param)
пользователя
public_cert
Публичный
String
BASE64
1
сертификат
пользователя *
* - Необходимо использовать публичный сертификат, а не публичный ключ. Так же допускается
использование серийного номера сертификата в десятичной форме или отпечатка сертификата
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
DELETE api/v1/users/5b5540c4-fbb0-4ad7-a038-c8222affab3f/delete_key HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"public_cert":
"MIIBjjCCAT2gAwIBAgIEWWJzHzAIBgYqhQMCAgMwMTELMAkGA1UEBhMCUlUxEjAQBgNVBAoMCUNyeXB0b1Byb
zEOMAwGA1UEAwwFQWxpYXMwHhcNMTcxMTEzMTczMjI4WhcNMTgxMTEzMTczMjI4WjAxMQswCQYDVQQGEwJSVTE
SMBAGA1UECgwJQ3J5cHRvUHJvMQ4wDAYDVQQDDAVBbGlhczBjMBwGBiqFAwICEzASBgcqhQMCAiQABgcqhQMCA
h4BA0MABEAIWARzAiI81k4i4Gz8EC7Ic01653JX5PCUfvgCBTpLduYtbTwLOwmGFcZzw9bwsxQpALqhcdRHxtx
1UEeNKJuMozswOTAOBgNVHQ8BAf8EBAMCA+gwEwYDVR0lBAwwCgYIKwYBBQUHAwIwEgYDVR0TAQH/BAgwBgEB/
wIBBTAIBgYqhQMCAgMDQQBL9CrIk0EgnMVr1J5dKbfXVFrhJxGxztFkTdmGkGJ6gHywB5Y9KpP67pv7I2bP1m1
ej9hu+C17GSJrWgMgq+UZ"
}
161
Получение результата:
HTTP код 200 OK
6.5. Изменение пароля пользователя (для нерезидентов)
6.5.1. Метод для изменения пароля пользователя (для нерезидентов)
Endpoint: PUT <endpoint>/<version>/users/{user_id}/change_password
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_id
Уникальный
String
UserID
1
Параметр пути
идентификатор
(path param)
пользователя
password
Пароль
String
1
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
PUT api/v1/users/5b5540c4-fbb0-4ad7-a038-c8222affab3f/change_password HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"password": "password1234"
}
Получение результата:
HTTP код 200 OK
162
6.6. Группы прав пользователей
6.6.1. Метод для получения информации о существующих правах
Endpoint: GET <endpoint>/<version>/rights/about
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
rights
Права и
Array of
RightsInfo
1
описание
Objects
Пример использования метода
Запрос:
GET api/v1/rights/about HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"rights": [
{
"right": "OUTCOME_LIST",
"description": "Позволяет получить информацию о исходящих документах"
},
{
"right": "UPLOAD_DOCUMENT",
"description": "Позволяет загружать документ"
},
{
"right": "REESTR_EGRIP",
"description": "Получение информации из реестра ЕГРИП"
},
163
{
"right": "MANAGE_ACCOUNTS",
"description": "Позволяет управлять учетными системами, пользователями, группами
прав пользователей"
},
{
"right": "VIEW_ACCOUNTS",
"description": "Позволяет просматривать учетные системы, пользователей, группы
прав пользователей"
},
{
"right": "INCOME_LIST",
"description": "Позволяет получить информацию о входящих документах"
},
{
"right": "DOWNLOAD_DOCUMENT",
"description": "Позволяет по идентификатору документа получить ссылку на
документ."
},
{
"right": "REESTR_ALL",
"description": "Позволяет получить доступ ко всем справочникам"
},
{
"right": "REESTR_FEDERAL_SUBJECT",
"description": "Получение информации из реестра субъектов Российской Федерации"
},
{
"right": "REESTR_EGRUL",
"description": "Получение информации из реестра ЕГРЮЛ"
},
{
"right": "REESTR_REFP",
"description": "Получение информации из реестра аккредитованных филиалов и
представительств"
},
{
"right": "REESTR_PROD_LICENSES",
"description": "Получение информации из реестра лицензий на производство "
},
{
"right": "REESTR_PHARM_LICENSES",
"description": "Получение информации из реестра лицензий на фармацевтическую
деятельность"
},
{
"right": "REESTR_ESKLP",
"description": "Получение информации из реестра ЕСКЛП"
},
{
"right": "REESTR_FIAS",
164
"description": "Получение информации из реестра ГАР/ФИАС"
}
]
}
6.6.2. Метод для получения информации о правах текущего пользователя
Endpoint: GET <endpoint>/<version>/rights/current
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
rights
Права и
Array of Strings
1
описание
Пример использования метода
Запрос:
GET api/v1/rights/current HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"rights": [
"OUTCOME_LIST",
"UPLOAD_DOCUMENT",
"MANAGE_ACCOUNTS",
"VIEW_ACCOUNTS",
"INCOME_LIST",
"DOWNLOAD_DOCUMENT",
"REESTR_ALL"
]
165
}
6.6.3. Метод для создания группы прав пользователей
Endpoint: POST <endpoint>/<version>/rights/create_group
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_name
Имя группы
String
1
rights
Права
Array of Strings
RightsEnum
1
пользователей,
принадлежащи
х этой группе
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_id
Уникальный
String
UUID
1
идентификатор
группы
Пример использования метода
Запрос:
POST api/v1/rights/create_group HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"group_name": "Тестовая группа",
"rights": [
"MANAGE_ACCOUNTS",
166
"VIEW_ACCOUNTS"
]
}
Получение результата:
{
"group_id": "a5d134fe-43cb-42a1-85eb-61a5cfcffef9"
}
6.6.4. Метод для получения информации о группе прав пользователей
Endpoint: GET <endpoint>/<version>/rights/{group_id}
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_id
Уникальный
String
UUID
1
Параметр
идентификатор
запроса (Path
группы
param)
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group
Объект типа
Object
ExtendedGroup
1
Group
Info
Пример использования метода
Запрос:
GET api/v1/rights/a5d134fe-43cb-42a1-85eb-61a5cfcffef9 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
167
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"group": {
"group_id": " a5d134fe-43cb-42a1-85eb-61a5cfcffef9",
"group_name": "Тестовая группа",
"rights": [
"MANAGE_ACCOUNTS",
"VIEW_ACCOUNTS"
],
"type": 0
}
}
6.6.5. Метод для получения информации о пользователях группы
Endpoint: GET <endpoint>/<version>/rights/{group_id}/users
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_id
Уникальный
String
UUID
1
Параметр
идентификатор
запроса (Path
группы
param)
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
users
Пользователи,
Array of
User
1
состоящие в
Objects
данной группе
Пример использования метода
168
Запрос:
GET api/v1/rights/a5d134fe-43cb-42a1-85eb-61a5cfcffef9/users HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"users": [
{
"user_id": "5b5540c4-fbb0-4ad7-a038-c8222affab3f",
"first_name": "Петр",
"last_name": "Петров",
"groups": [
"Тестовая группа"
]
}
]
}
6.6.6. Метод для изменения группы прав пользователей
Endpoint: PUT <endpoint>/<version>/rights/{group_id}
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_id
Уникальный
String
UUID
1
Параметр
идентификатор
запроса (Path
группы
param)
group_change
Объект типа
Object
GroupInfo
1
GroupInfo
Выходная информация
По результатам выполнения клиент получает следующую информацию:
169
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group
Объект типа
Object
ExtendedGroup
1
Group
Info
Пример использования метода
Запрос:
PUT api/v1/rights/a5d134fe-43cb-42a1-85eb-61a5cfcffef9 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"group_change": {
"group_name": "Тестовая группа2",
"rights": [
"OUTCOME_LIST",
"MANAGE_ACCOUNTS",
"VIEW_ACCOUNTS"
]
}
}
Получение результата:
{
"group": {
"group_id": " a5d134fe-43cb-42a1-85eb-61a5cfcffef9",
"group_name": "Тестовая группа2",
"rights": [
"OUTCOME_LIST",
"MANAGE_ACCOUNTS",
"VIEW_ACCOUNTS"
],
"type": 0
}
}
6.6.7. Метод для удаления группы прав пользователей
Endpoint: DELETE <endpoint>/<version>/rights/{group_id}
Необходимые права доступа: MANAGE_ACCOUNTS
170
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_id
Уникальный
String
UUID
1
Параметр
идентификатор
запроса (Path
группы
param)
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
DELETE api/v1/rights/a5d134fe-43cb-42a1-85eb-61a5cfcffef9 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
HTTP код 200 OK
6.6.8. Метод для добавления пользователя в группу прав пользователей
Endpoint: POST <endpoint>/<version>/rights/{group_id}/user_add
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
171
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_id
Уникальный
String
UUID
1
Параметр
идентификатор
запроса (Path
группы
param)
user_id
Уникальный
String
UserID
1
идентификатор
пользователя
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
POST api/v1/rights/a5d134fe-43cb-42a1-85eb-61a5cfcffef9/user_add HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"user_id": "5b5540c4-fbb0-4ad7-a038-c8222affab3f"
}
Получение результата:
HTTP код 200 OK
6.6.9. Метод для удаления пользователя из группы прав пользователей
Endpoint: DELETE <endpoint>/<version>/rights/{group_id}/{user_id}
Необходимые права доступа: MANAGE_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
172
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_id
Уникальный
String
UUID
1
Параметр пути
идентификатор
(path param)
группы
user_id
Уникальный
String
UserID
1
Параметр пути
идентификатор
(path param)
пользователя
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
DELETE api/v1/rights/a5d134fe-43cb-42a1-85eb-61a5cfcffef9/5b5540c4-fbb0-4ad7-a038-
c8222affab3f HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
HTTP код 200 OK
6.6.10. Метод для получения списка групп прав пользователей (Устарел)
Endpoint: POST <endpoint>/<version>/rights/list
Данный метод является устаревшим и подлежит удалению.
ВАЖНО
Необходимо использовать новый метод: Метод для поиска списка групп прав
пользователей по фильтру. Дата устаревания 2021-05-05.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
group_filter
Объект типа
Object
GroupInfo
1
GroupInfo
173
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
1
записи в
списке
возвращаемых
документов
count
Количество
Number
1
записей в
списке
возвращаемых
документов
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
groups
Найденные
Array of
ExtendedGroup
1
группы
Objects
Info
total
Общее
Number
1
количество
записей по
запросу
Пример использования метода
Запрос:
POST api/v1/rights/list HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"group_filter": {
"group_name": "Тестовая группа"
},
"start_from": "0",
"count": "10"
}
174
Получение результата:
{
"total": 1,
"groups": [
{
"group_id": " a5d134fe-43cb-42a1-85eb-61a5cfcffef9",
"group_name": "Тестовая группа2",
"rights": [
"OUTCOME_LIST",
"MANAGE_ACCOUNTS",
"VIEW_ACCOUNTS"
],
"type": 0
}
]
}
6.6.11. Метод для поиска списка групп прав пользователей по фильтру
Endpoint: POST <endpoint>/<version>/rights/filter
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Объект типа
Object
GroupFilter
1
GroupInfo
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Выходная информация
По результатам выполнения клиент получает следующую информацию:
175
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
groups
Найденные
Array of
ExtendedGroup
1
группы
Objects
Info
total
Общее
Number
1
количество
записей по
запросу
Пример использования метода
Запрос:
POST api/v1/rights/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": {
"group_name": "Тестовая группа",
"type": 0
},
"start_from": "0",
"count": "10"
}
Получение результата:
{
"total": 1,
"groups": [
{
"group_id": " a5d134fe-43cb-42a1-85eb-61a5cfcffef9",
"group_name": "Тестовая группа2",
"rights": [
"OUTCOME_LIST",
"MANAGE_ACCOUNTS",
"VIEW_ACCOUNTS"
],
"type": 0
}
]
}
176
6.7. Поиск по зарегистрированным пользователям
6.7.1. Метод для поиска по зарегистрированным пользователям (Устарел)
Endpoint: POST <endpoint>/<version>/users/find
Данный метод является устаревшим и подлежит удалению.
ВАЖНО
Необходимо
использовать
новый
метод:
Метод
для
поиска
зарегистрированных пользователей по фильтру. Дата устаревания 2021-05-05.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
user_filter
Данные для
Object
UserInfo
1
поиска
пользователя
start_from
Индекс первой
Number
1
записи в
списке
возвращаемых
документов
count
Количество
Number
1
записей в
списке
возвращаемых
документов
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
users
Пользователи
Array of
GroupedUser
1
Objects
total
Общее
Number
1
количество
записей по
запросу
Пример использования метода
177
Запрос:
POST api/v1/users/find HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"user_filter": {
"first_name": "Петр"
},
"start_from": "0",
"count": "10"
}
Получение результата:
{
"total": 1,
"users": [
{
"user_id": "5b5540c4-fbb0-4ad7-a038-c8222affab3f",
"first_name": "Петр",
"last_name": "Петров",
"groups": [
"Тестовая группа2"
]
}
]
}
6.7.2. Метод для поиска зарегистрированных пользователей по фильтру
Endpoint: POST <endpoint>/<version>/users/filter
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
178
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Данные для
Object
UserFilter
1
поиска
пользователя
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Формат объекта UserFilter
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
first_name
Имя
String
0
пользователя
last_name
Фамилия
String
0
пользователя
middle_name
Отчество
String
0
пользователя
login
Логин
String
0
пользователя
is_admin
Признак
Boolean
0
администратор
а участника
is_responsible
Признак
Boolean
0
наличия
доступа к
системным
группам
участника
statuses
Статусы
Array of Strings
UserStatus
0
пользователя
user_id
Идентификато
String
0
р пользователя
Выходная информация
По результатам выполнения клиент получает следующую информацию:
179
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
users
Пользователи
Array of
GroupedUser
1
Objects
total
Общее
Number
1
количество
записей по
запросу
Пример использования метода
Запрос:
POST api/v1/users/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": {
"first_name": "Петр",
"is_admin": false
},
"start_from": "0",
"count": "10"
}
Получение результата:
{
"total": 1,
"users": [
{
"user_id": "5b5540c4-fbb0-4ad7-a038-c8222affab3f",
"first_name": "Петр",
"last_name": "Петров",
"middle_name": "Петрович",
"position": "Директор",
"login": "test@mail.ru",
"sys_id": "4b73cb20-69fb-44e6-ab17-65a9314e6068",
"is_admin": false,
"is_responsible": false,
"groups": [
"Тестовая группа2"
]
180
}
]
}
6.8. Поиск по УС
6.8.1. Метод для поиска по УС (Устарел)
Endpoint: POST <endpoint>/<version>/account_systems/find
Данный метод является устаревшим и подлежит удалению.
ВАЖНО
Необходимо использовать новый метод: Метод для поиска УС по фильтру.
Дата устаревания 2021-05-05.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
name
Название УС
String
1
start_from
Индекс первой
Number
1
записи в
списке
возвращаемых
документов
count
Количество
Number
1
записей в
списке
возвращаемых
документов
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
account_system
Учетные
Array of
AccountSystem
1
s
системы
Objects
total
Общее
Number
1
количество
записей по
запросу
181
Пример использования метода
Запрос:
POST api/v1/account_systems/find HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"name": "Тестовая УС",
"start_from": "0",
"count": "10"
}
Получение результата:
{
"total": 1,
"account_systems": [
{
"account_system_id": "7baf5610-554f-4887-8f41-1fc7f07449d5",
"name": "Тестовая УС для компании ООО Медицина",
"client_id": "7df0d06f-6510-44fe-a378-76cb53e2605f"
}
]
}
6.8.2. Метод для поиска УС по фильтру
Endpoint: POST <endpoint>/<version>/account_systems/filter
Необходимые права доступа: VIEW_ACCOUNTS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Данные для
Object
AccountSystem
1
поиска УС
Filter
182
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Формат объекта AccountSystemFilter
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
name
Название УС
String
1
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
account_system
Учетные
Array of
AccountSystem
1
s
системы
Objects
total
Общее
Number
1
количество
записей по
запросу
Пример использования метода
Запрос:
POST api/v1/account_systems/find HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {
"name": "Тестовая УС"
},
"start_from": "0",
183
"count": "10"
}
Получение результата:
{
"total": 1,
"account_systems": [
{
"account_system_id": "7baf5610-554f-4887-8f41-1fc7f07449d5",
"name": "Тестовая УС для компании ООО Медицина",
"client_id": "7df0d06f-6510-44fe-a378-76cb53e2605f"
}
]
}
6.8.3. Метод добавления ЭП пользователя для самого себя
Endpoint: POST <endpoint>/<version>/users/own/add_key
Для доступа не требуется прав
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
public_cert
Публичный
String
BASE64
1
Необходимо
сертификат
использовать
пользователя
публичный
сертификат, а
не публичный
ключ
Выходная информация
По результатам выполнения клиент получает HTTP код завершения операции с пустым телом
ответа.
Пример использования метода
Запрос:
POST api/v1/users/own/add_key HTTP/1.1
Host: api.sb.mdlp.ru
184
Content-Type: application/json
Authorization: token 27b06208-d46c-4993-aad1-7e2c18fa952e
{
"public_cert": "MIIJETCCCL6gAwIBAgIRA4BqpQDQrpSfQmTMTVrLA+gwCgYIKoUDBwEBAwIwggFW
MRUwEwYFKoUDZAQSCjc3MTcxMDc5OTExIDAeBgkqhkiG9w0BCQEWEWluZm9AY3J5
cHRvcHJvLnJ1MRgwFgYFKoUDZAESDTEwMzc3MDAwODU0NDQxCzAJBgNVBAYTAlJV
MRgwFgYDVQQIDA83NyDQnNC+0YHQutCy0LAxFTATBgNVBAcMDNCc0L7RgdC60LLQ
sDEvMC0GA1UECQwm0YPQuy4g0KHRg9GJ0ZHQstGB0LrQuNC5INCy0LDQuyDQtC4g
MTgxJTAjBgNVBAoMHNCe0J7QniAi0JrQoNCY0J/QotCeLdCf0KDQniIxazBpBgNV
BAMMYtCi0LXRgdGC0L7QstGL0Lkg0L/QvtC00YfQuNC90LXQvdC90YvQuSDQo9Cm
INCe0J7QniAi0JrQoNCY0J/QotCeLdCf0KDQniIg0JPQntCh0KIgMjAxMiAo0KPQ
piAyLjApMB4XDTIyMDcxMjA5NTIxNloXDTIyMTAxMjEwMDIxNlowggG3MRUwEwYF
KoUDZAQSCjc3MTQzMzU5MTExGDAWBgUqhQNkARINMTE1Nzc0NjMyOTU5NzEbMBkG
A1UEDAwS0JHRg9GF0LPQsNC70YLQtdGAMV8wXQYDVQQKDFbQntCR0KnQldCh0KLQ
ktCeINChINCe0JPQoNCQ0J3QmNCn0JXQndCd0J7QmSDQntCi0JLQldCi0KHQotCS
0JXQndCd0J7QodCi0KzQriAi0JvQmNChIjF0MHIGA1UECQxrMTI3MDgzLCDQk9Ce
0KDQntCUINCc0J7QodCa0JLQkCwg0JLQldCg0KXQndCv0K8g0JzQkNCh0JvQntCS
0JrQkCDQo9Cb0JjQptCQLCDQlNCe0JwgMTEsINCa0JLQkNCg0KLQmNCg0JAgMzIx
FTATBgNVBAcMDNCc0J7QodCa0JLQkDELMAkGA1UECAwCNzcxCzAJBgNVBAYTAlJV
MS4wLAYDVQQqDCXQkNC70LXQutGB0LDQvdC00YAg0KHQtdGA0LPQtdC10LLQuNGH
MRUwEwYDVQQEDAzQn9GD0YjQutC40L0xGDAWBgNVBAMMD9Ce0J7QniAi0JvQmNCh
IjBmMB8GCCqFAwcBAQEBMBMGByqFAwICJAAGCCqFAwcBAQICA0MABEBA6qa75crv
FcVWQRHZ0azx37bJniQg/KYlmQ5AVmCuumpHnVKwH05eo9J1P+Zu+yaldfiPCmsH
A1xP1bUPxAU2o4IE+TCCBPUwDgYDVR0PAQH/BAQDAgTwMB8GCSsGAQQBgjcVBwQS
MBAGCCqFAwICLgAIAgEBAgEAMB0GA1UdDgQWBBRN4buLQZsIV7uXOZaCGVKHvMAG
/zAmBgNVHSUEHzAdBggrBgEFBQcDBAYIKwYBBQUHAwIGByqFAwICIgYwMgYJKwYB
BAGCNxUKBCUwIzAKBggrBgEFBQcDBDAKBggrBgEFBQcDAjAJBgcqhQMCAiIGMIGo
BggrBgEFBQcBAQSBmzCBmDA5BggrBgEFBQcwAYYtaHR0cDovL3Rlc3RjYTIwMTIu
Y3J5cHRvcHJvLnJ1L29jc3AyL29jc3Auc3JmMFsGCCsGAQUFBzAChk9odHRwOi8v
dGVzdGNhMjAxMi5jcnlwdG9wcm8ucnUvYWlhLzc1OGQxYmY3MzJkMmQwZjI1ZjFl
MGY5ZTEzNzllYmZjMjBmZTllMmYuY3J0MB0GA1UdIAQWMBQwCAYGKoUDZHECMAgG
BiqFA2RxATArBgNVHRAEJDAigA8yMDIyMDcxMjA5NTIxNVqBDzIwMjIxMDEyMDk1
MjE1WjCCARoGBSqFA2RwBIIBDzCCAQsMNNCh0JrQl9CYICLQmtGA0LjQv9GC0L7Q
n9GA0L4gQ1NQIiAo0LLQtdGA0YHQuNGPIDQuMCkMMdCf0JDQmiAi0JrRgNC40L/R
gtC+0J/RgNC+INCj0KYiINCy0LXRgNGB0LjQuCAyLjAMT9Ch0LXRgNGC0LjRhNC4
0LrQsNGCINGB0L7QvtGC0LLQtdGC0YHRgtCy0LjRjyDihJYg0KHQpC8xMjQtMzk3
MSDQvtGCIDE1LjAxLjIwMjEMT9Ch0LXRgNGC0LjRhNC40LrQsNGCINGB0L7QvtGC
0LLQtdGC0YHRgtCy0LjRjyDihJYg0KHQpC8xMjgtMzg3MCDQvtGCIDIzLjA3LjIw
MjAwLAYFKoUDZG8EIwwh0KHQmtCX0JggItCa0YDQuNC/0YLQvtCf0YDQviBDU1Ai
MGAGA1UdHwRZMFcwVaBToFGGT2h0dHA6Ly90ZXN0Y2EyMDEyLmNyeXB0b3Byby5y
dS9jZHAvNzU4ZDFiZjczMmQyZDBmMjVmMWUwZjllMTM3OWViZmMyMGZlOWUyZi5j
cmwwDAYFKoUDZHIEAwIBAjCCAZIGA1UdIwSCAYkwggGFgBR1jRv3MtLQ8l8eD54T
eev8IP6eL6GCAVikggFUMIIBUDELMAkGA1UEBhMCUlUxFTATBgUqhQNkBBIKNzcx
NzEwNzk5MTEgMB4GCSqGSIb3DQEJARYRaW5mb0BjcnlwdG9wcm8ucnUxGDAWBgUq
hQNkARINMTAzNzcwMDA4NTQ0NDEYMBYGA1UECAwPNzcg0JzQvtGB0LrQstCwMRUw
EwYDVQQHDAzQnNC+0YHQutCy0LAxLzAtBgNVBAkMJtGD0LsuINCh0YPRidGR0LLR
gdC60LjQuSDQstCw0Lsg0LQuIDE4MSUwIwYDVQQKDBzQntCe0J4gItCa0KDQmNCf
0KLQni3Qn9Cg0J4iMWUwYwYDVQQDDFzQotC10YHRgtC+0LLRi9C5INCz0L7Qu9C+
0LLQvdC+0Lkg0KPQpiDQntCe0J4gItCa0KDQmNCf0KLQni3Qn9Cg0J4iINCT0J7Q
odCiIDIwMTIgKNCj0KYgMi4wKYIRA/iYhQBxreGMTXtLRsV/FUIwCgYIKoUDBwEB
185
AwIDQQDksx/o6dtzIR6iQBT6iv7gj6veYeqK1Ox3mIB8wrHlvPOJgXgFtJCaL/db
deMAUIfF0hbot/hHgvTfxa6BA+8B"
}
Получение результата:
HTTP код 200 OK
6.8.4. Метод для получения информации о своих зарегистрированных сертификатах
пользователя
Endpoint: POST <endpoint>/<version>/users/own/keys
Для доступа не требуется прав
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
filter
Фильтрация по
Object
UserCertsFilter
0
параметрам
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
certs
Сертификаты
Array of
UserCert
1
(ключи)
Objects
пользователя
total
Общее
Number
1
количество
записей по
запросу
Формат объекта UserCert описан выше.
186
Формат объекта UserCertsFilter описан выше.
Пример использования метода
Запрос:
POST api/v1/users/own/keys HTTP/1.1
Host: api.sb.mdlp.ru
Accept: application/json
Content-Type: application/json
Authorization: token 56768fcb-148b-4180-b908-a2d3b0ff3113
{
"start_from": 0,
"count": 1,
"filter": {},
}
Получение результата:
{
"total": 19,
"certs": [
{
"public_cert_serial_number": "1006099476806282493708187560545295674412",
"public_cert_thumbprint": "8C57635C24639F81BEC651F684544CDF6C6A310C",
"valid_from": "07-06-2021 13:55:57",
"valid_to": "07-09-2021 14:05:57",
"org_name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"СЕВАСТОПОЛЬСКАЯ
ГЕО-ПА",
"owner": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"СЕВАСТОПОЛЬСКАЯ ГЕО-
ПА",
"inn": "009201002445",
"position": "ГЕНЕРАЛЬНЫЙ ДИРЕКТОР",
"owner_fio": "ИВАНОВ ДМИТРИЙ ОЛЕГОВИЧ",
"issuer_name": "CN=\"Тестовый подчиненный УЦ ООО \\\"КРИПТО-ПРО\\\" ГОСТ
2012 (УЦ 2.0)\", O=\"ООО \\\"КРИПТО-ПРО\\\"\", STREET=ул. Сущёвский вал д. 18,
L=Москва, ST=77 Москва, C=RU, OID.1.2.643.3.131.1.1=#120C303037373137313037393931,
OID.1.2.643.100.1=#120D31303337373030303835343434, EMAILADDRESS=info@cryptopro.ru"
}
]
}
6.8.5. Метод для поиска списка собственных групп прав по фильтру
Endpoint: POST <endpoint>/<version>/rights/own/filter
Необходимые права доступа: Нет
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
187
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Объект типа
Object
GroupFilter
1
GroupInfo
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
groups
Найденные
Array of
ExtendedGroup
1
группы
Objects
Info
total
Общее
Number
1
количество
записей по
запросу
Пример использования метода
Запрос:
POST api/v1/rights/own/filter HTTP/1.1
Host: api.sb.mdlp.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {
"group_name": "Тестовая группа",
"type": 0
},
"start_from": "0",
"count": "10"
188
}
Получение результата:
{
"total": 1,
"groups": [
{
"group_id": " a5d134fe-43cb-42a1-85eb-61a5cfcffef9",
"group_name": "Тестовая группа2",
"rights": [
"OUTCOME_LIST",
"MANAGE_ACCOUNTS",
"VIEW_ACCOUNTS"
],
"type": 0
}
]
}
6.8.6. Метод для получения информации о вариантах собственных прав
Endpoint: GET <endpoint>/<version>/rights/own/about
Необходимые права доступа: Нет
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
rights
Права и
Array of
RightsInfo
1
описание
Objects
Пример использования метода
Запрос:
GET api/v1/rights/own/about HTTP/1.1
Host: api.sb.mdlp.ru
Accept: application/json
189
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"rights": [
{
"right": "OUTCOME_LIST",
"description": "Позволяет получить информацию о исходящих документах"
},
{
"right": "UPLOAD_DOCUMENT",
"description": "Позволяет загружать документ"
},
{
"right": "REESTR_EGRIP",
"description": "Получение информации из реестра ЕГРИП"
},
{
"right": "MANAGE_ACCOUNTS",
"description": "Позволяет управлять учетными системами, пользователями, группами
прав пользователей"
},
{
"right": "VIEW_ACCOUNTS",
"description": "Позволяет просматривать учетные системы, пользователей, группы
прав пользователей"
},
{
"right": "INCOME_LIST",
"description": "Позволяет получить информацию о входящих документах"
},
{
"right": "DOWNLOAD_DOCUMENT",
"description": "Позволяет по идентификатору документа получить ссылку на
документ."
},
{
"right": "REESTR_ALL",
"description": "Позволяет получить доступ ко всем справочникам"
},
{
"right": "REESTR_FEDERAL_SUBJECT",
"description": "Получение информации из реестра субъектов Российской Федерации"
},
{
"right": "REESTR_EGRUL",
"description": "Получение информации из реестра ЕГРЮЛ"
},
{
190
"right": "REESTR_REFP",
"description": "Получение информации из реестра аккредитованных филиалов и
представительств"
},
{
"right": "REESTR_PROD_LICENSES",
"description": "Получение информации из реестра лицензий на производство "
},
{
"right": "REESTR_PHARM_LICENSES",
"description": "Получение информации из реестра лицензий на фармацевтическую
деятельность"
},
{
"right": "REESTR_ESKLP",
"description": "Получение информации из реестра ЕСКЛП"
},
{
"right": "REESTR_FIAS",
"description": "Получение информации из реестра ГАР/ФИАС"
}
]
}
191
7. Получение справочной информации
Здесь содержится информация из сторонних сервисов. Данная информация меняется редко или
не меняется совсем.
7.1. Получение информации из реестра ЕГРЮЛ
7.1.1. Получение данных записи ЕГРЮЛ
Endpoint: GET <endpoint>/<version>/reestr/egrul
Необходимые права доступа (любое из): REESTR_ALL, REESTR_EGRUL
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
1
р записи в
ЕГРЮЛ
inn
ИНН
String
1
юридического
лица
OGRN
ОГРН
String
1
KPP
КПП
String
1
FIRST_NAME
Имя
String
1
MIDDLE_NA
Отчество
String
1
ME
LAST_NAME
Фамилия
String
1
ORG_NAME
Наименование
String
1
организации
Пример использования метода
Запрос:
GET api/v1/reestr/egrul HTTP/1.1
Host: api.sb.mdlp.crpt.ru
192
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"id": "59ee5850763afe8ac1a26b90",
"inn": "7720672100",
"OGRN": "1025213731937",
"KPP": "525351001",
"FIRST_NAME": "Дмитрий",
"MIDDLE_NAME": "Дмитриевич",
"LAST_NAME": "Дмитриев",
"ORG_NAME": "Акционерное общество \"Медицина\""
}
7.2. Получение информации из реестра ЕГРИП
7.2.1. Получение данных записи ЕГРИП
Endpoint: GET <endpoint>/<version>/reestr/egrip
Необходимые права доступа (любое из): REESTR_ALL, REESTR_EGRIP
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
1
р записи в
ЕГРИП
inn
ИНН
String
1
индивидуальн
ого
предпринимат
еля
FIRST_NAME
Имя
String
1
193
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
MIDDLE_NA
Отчество
String
1
ME
LAST_NAME
Фамилия
String
1
Пример использования метода
Запрос:
GET api/v1/reestr/egrip HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"id": "59ee5850762afe8ac1a26c0f",
"inn": "402507520623",
"FIRST_NAME": "Иван",
"MIDDLE_NAME": "Иванович",
"LAST_NAME": "Иванов"
}
7.3. Получение информации из реестра аккредитованных
филиалов и представительств
7.3.1. Получение записи реестра РАФП
Endpoint: GET <endpoint>/<version>/reestr/rafp
Необходимые права доступа (любое из): REESTR_ALL, REESTR_REFP
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
Выходная информация содержит следующие данные:
194
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
1
р записи в
ЕГРЮЛ
inn
ИНН
String
1
юридического
лица
FIRST_NAME
Имя
String
1
MIDDLE_NA
Отчество
String
1
ME
LAST_NAME
Фамилия
String
1
KPP
КПП
String
1
Пример использования метода
Запрос:
GET api/v1/reestr/rafp HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"id": "59ee5850763afe8ac1a26b90",
"inn": "7720672100",
"KPP": "525351001",
"FIRST_NAME": "Дмитрий",
"MIDDLE_NAME": "Дмитриевич",
"LAST_NAME": "Дмитриев"
}
7.4. Получение информации из реестра налоговой
задолженности
7.4.1. Получение информации о задолженности (Устарел)
Endpoint: GET <endpoint>/<version>/reestr/dues
Данный метод является устаревшим и подлежит удалению. Дата устаревания
ВАЖНО
2021-05-05.
195
Необходимые права доступа (любое из): REESTR_ALL, REESTR_DUES
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
1
р записи в
ЕГРЮЛ
inn
ИНН
String
1
юридического
лица
BACKLOG_S
Сумма
String
1
UM
задолженности
Пример использования метода
Запрос:
GET api/v1/reestr/dues HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"id": "59ee5850762afe8ac1a26c18",
"inn": "4025075206",
"BACKLOG_SUM": "1000000"
}
7.5. Получение информации из реестра ГАР/ФИАС
7.5.1. Получение текстового адреса по идентификаторам ГАР/ФИАС
Endpoint: POST <endpoint>/<version>/reestr/fias/resolve
196
Необходимые права доступа (любое из): REESTR_ALL, REESTR_FIAS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Данный метод имеет следующие входные параметры:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
aoguid
Уникальный
String
UUID
1
идентификатор
адресного
объекта
(ГАР/ФИАС)
houseguid
Адрес
String
UUID
1
установки (код
ГАР/ФИАС)
room
Комната
String
1-50 символов
0
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
code
Код
String
1
•
0 - операц
выполнения
ия
операции
выполнена
успешно,
адрес
найден
•
1 - адрес
не может
быть
идентифиц
ирован в
БД
ГАР/ФИАС
address
Текстовый
String
1
адрес объекта
Пример использования метода
Запрос:
197
POST api/v1/reestr/fias/resolve HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"aoguid": "353b7aed-0f1b-4f44-8ce3-245083e17526",
"houseguid": "ba1c2f28-a455-47e2-95e5-000003a0023d",
"room": "10"
}
Получение результата:
{
"code": "0",
"address": "Адыгея Респ, р-н Красногвардейский, х Чумаков, ул Широкая, д 2, 10"
}
7.6. Получение информации из реестра лицензий на
производство
7.6.1. Получение информации о лицензиях на производство
Endpoint: GET <endpoint>/<version>/reestr/prod_licenses
Необходимые права доступа (любое из): REESTR_ALL, REESTR_PROD_LICENSES
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входная информация не требуется.
Выходная информация
Выходная информация содержит массив следующих данных:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
1
р записи в
реестре
inn
ИНН
String
1
юридического
лица
198
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
ORG_NAME
Название
String
1
организации,
которой
выдана
лицензия
L_NUM
Номер
String
1
лицензии
START_DATE
Дата начала
String
1
действия
лицензии
END_DATE
Дата
String
0
окончания
действия
лицензии
L_STATUS
Статус
String
1
Возможные
лицензии
значения:
Действующая;
Недействующа
я;
Приостановле
нная;
Приостановле
на частично;
Прекращена;
Аннулирована
ADDRESS
Адрес
Object
Address
1
действия
лицензии
WORK_LIST
Перечень
Array of Strings
1
работ/услуг
согласно
лицензии
Пример использования метода
Запрос:
GET api/v1/reestr/prod_licenses HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
199
содержание .. 2 3 4 5 ..
|
||
|
|
|