Сертификаты
Сертификаты пользователя
URL https://server_name/sign/cer
Request
- Content-type
multipart/form-data - Body
FORMDATA- key = полученный ключ доступа
- user_ph= +79001234567 или
- company_ogrn= 1234567890123
- get_active_certs = one of
- 0 - неактивные
- 1 - активные
- 2 - все
- get_all_certs = one of
- 0 - на юзера
- 1 - на компании
- 2 -все
- format= 0 - pem, 1 - cer
Response
- Success
- Content-type
application/json - Body
JSON- id ключа = base64_encode (сертификат)
- Content-type
- Error
- Content-type
text/plain - Body
TEXTerror 0: POSTиспользуйте POSTerror 1: no phone or ogrnнет ни телефона пользователя, ни ОГРНerror 2: no userнет пользователя с таким телефономerror 3: no companyнет компании с таким ОГРНerror 4: wrong typeнеправильный get_all_certserror 5: no keysнет ключей с искомыми параметрами (активные и т.д.)
- Content-type
Подробности ключей
URL https://server_name/certapi/keys
Request
- Content-type
application/json - Body
JSON- api_key = полученный ключ доступа
- snils = СНИЛС
- inn = ИНН компании
- kpp = КПП компании
(при подаче только СНИЛС - в ответе только ключи ФЛ. СНИЛС + ИНН и КПП - ключи ФЛ и ИП/ЮЛ)
Response
- Success
- Content-type
application/json - Body
JSON- array of
- “id”: 123456 - ID ключа
- “captain”: true / false - квалифицированный сертификат
- “mobile”: true / false - мобильный ключ
- “company”: true / false - ключ компании с этим ИНН
- “finish”: “2021-01-01 00:00” - дата окончания сертификата
- “esia”: true / false - идентификация через ЕСИА
- “mine”: true / false - ключ выпущен от источника api_key
- array of
- Content-type
- Error
- Content-type
application/json - Body
JSON- error = one of
Wrong apikeyнет такого АПИ-ключаWrong snilsнет такого снилсWrong innнет такого инн
- error = one of
- Content-type
Отзыв сертификата
Если АПИ-ключу разрешено отзывать сертификаты
URL https://server_name/certapi/revoke
Request
- Content-type
application/json - Body
JSON- api_key = полученный ключ доступа
- id = ID ключа (можно получить в АПИ сертификатов или в АПИ подробности ключей)
- revokeauth = 1 если также нужно отозвать сертификат аутентификации, иначе не подавать
Response
- Success
- Content-type
application/json - Body
JSON- url = ссылка на подписание заявления на отзыв сертификата
- Content-type
- Error
- Content-type
application/json - Body
JSON- error = one of
Wrong apikeyнеправильный апи-ключWrong key idнеправильный идентификатор отзываемого ключа
- error = one of
- Content-type
Список типов сертификатов
URL https://server_name/certapi/get_crttypes
Request
- Content-type
application/json - Body
JSON- api_key = полученный ключ доступа
Response
- Success
- Content-type
application/json - Body
JSON
[{
"id": Идентификатор типа сертификата для использования далее,
"name": Название,
"descr": Описание,
"profile": 0 - ФЛ, 1 - ИП, 2 - ООО,
"alg": Название алгоритма,
}]
- Content-type
- Error
- Content-type
application/json - Body
JSON- error = one of
Wrong apikeyнеправильный апи-ключ
- error = one of
- Content-type
Список тарифов
URL https://server_name/certapi/get_rates
Request
- Content-type
application/json - Body
JSON- api_key = полученный ключ доступа
- crttype_id = идентификатор типа сертификата из предыдущего апи
Response
- Success
- Content-type
application/json - Body
JSON
[{
"id": Идентификатор тарифа для использования далее,
"name": Название,
"descr": Описание,
"type": 0 - безлимитный, 1 - пакет подписей, 2 - по одной подписи, 3 - абонентская плата,
"period": Сколько дней/месяцев/лет если абонентская плата,
"unit": 0 - дней, 1 - месяцев, 2 - лет,
"price": Цена (за период если абонентская плата),
}]
- Content-type
- Error
- Content-type
application/json - Body
JSON- error = one of
Wrong apikeyнеправильный апи-ключWrong ctidнесуществующий идентификатор типа сертификата
- error = one of
- Content-type
Добавление заявки на выпуск сертификата
URL https://server_name/certapi/addkey
Request
- Content-type
application/json - Body
JSON- api_key = полученный ключ доступа
- user_id = идентификатор пользователя из АПИ регистрации
- company_id = идентификатор компании из АПИ регистрации, необязательно
- crttype_id = идентификатор типа сертификата из предыдущего апи
- rate_id = идентификатор тарифа из предыдущего апи
- ca = имя УЦ, необязательно
- keytype = место хранения сертификата, 0 - сервер, 1 - мобильное устройство
- name = название ключа, необязательно
Response
-
Success
- Content-type
application/json - Body
JSON- id: Идентификатор заявки
- Content-type
-
Error
- Content-type
application/json - Body
JSON- error = one of
Wrong apikeyнеправильный апи-ключWrong useridнеправильный идентификатор пользователяWrong comidнеправильный идентификатор компанииWrong ctidнеправильный идентификатор типа сертификатаWrong rateidнеправильный идентификатор тарифаWrong caнеправильное имя УЦWrong keytypeнеправильное или недоступное место храненияExceptionошибка базы данных
- error = one of
- Content-type