Перейти к содержанию

Сертификаты

Сертификаты пользователя

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 (сертификат)
  • Error
    • Content-type text/plain
    • Body TEXT
      • error 0: POST используйте POST
      • error 1: no phone or ogrn нет ни телефона пользователя, ни ОГРН
      • error 2: no user нет пользователя с таким телефоном
      • error 3: no company нет компании с таким ОГРН
      • error 4: wrong type неправильный get_all_certs
      • error 5: no keys нет ключей с искомыми параметрами (активные и т.д.)

Подробности ключей

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
  • Error
    • Content-type application/json
    • Body JSON
      • error = one of
        • Wrong apikey нет такого АПИ-ключа
        • Wrong snils нет такого снилс
        • Wrong inn нет такого инн

Отзыв сертификата

Если АПИ-ключу разрешено отзывать сертификаты

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 = ссылка на подписание заявления на отзыв сертификата
  • Error
    • Content-type application/json
    • Body JSON
      • error = one of
        • Wrong apikey неправильный апи-ключ
        • Wrong key id неправильный идентификатор отзываемого ключа

Список типов сертификатов

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": Название алгоритма,
      }]
  • Error
    • Content-type application/json
    • Body JSON
      • error = one of
        • Wrong apikey неправильный апи-ключ

Список тарифов

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": Цена (за период если абонентская плата),
      }]
  • Error
    • Content-type application/json
    • Body JSON
      • error = one of
        • Wrong apikey неправильный апи-ключ
        • Wrong ctid несуществующий идентификатор типа сертификата

Добавление заявки на выпуск сертификата

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: Идентификатор заявки
  • 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 ошибка базы данных