Получить список КСКПЭП
Внимание
Новые ключи временно не выпускаются в связи с обновлением продукта.
Возвращает информацию обо всех сертификатах КСКПЭП, привязанных к компании.
Формат запроса
GET https://api.ofd.yandex.net/{v1}/companies/{company_id}/signs
Номер версии API ОФД.
Идентификатор компании. Присваивается автоматически при регистрации компании в системе Яндекс ОФД.
-
- v1
- Номер версии API ОФД.
-
- company_id
- Идентификатор компании. Присваивается автоматически при регистрации компании в системе Яндекс ОФД.
Заголовок запроса
Заголовки запроса должны содержать ключи (см. раздел Доступ к API):
Заголовок | Значение |
---|---|
X-Yandex-Key |
<аутентификационный ключ> |
X-OFD-Key |
<авторизационный ключ> |
Общий формат ответа приведен ниже. В реальном ответе порядок следования элементов может отличаться, а некоторые элементы могут отсутствовать. Также в ответе могут находиться служебные параметры, которые не описаны в документе.
Формат ответа
[
{
"session_expires_at": "{string}",
"expires_at": "{string}",
"id": {number},
"session_started_at": "{string}",
"is_patching": {boolean},
"signer": {
"email": "{string}",
"address": "{string}",
"name": {
"first": "{string}",
"middle": "{string}",
"last": "{string}"
},
"phone": "{string}",
"position": "{string}"
},
"company_id": {number},
"status": "{string}"
}
]
-
- session_expires_at
- Дата и время завершения сессии.
-
- expires_at
- Дала и время завершения срока действия КСКПЭП.
-
- id
- Идентификатор КСКПЭП.
-
- session_started_at
- Дата и время начала сессии.
-
- is_patching
- Возможность изменить номер телефона подписанта, указанный в заявке на создание КСКПЭП.
-
- signer
- Данные подписанта.
-
- name
- ФИО.
-
- first
- Имя.
-
- middle
- Отчество.
-
- last
- Фамилия
-
-
- position
- Занимаемая должность подписанта.
-
- address
- Юридический адрес компании.
-
- Адрес электронной почты подписанта.
-
- phone
- Номер телефона подписанта. Используется для получения пароля активации сессий электронной подписи.
-
-
- company_id
- Идентификатор компании системе Яндекс ОФД.
Коды ответа
Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.
Пример запроса
Метод и адрес:
GET https://api.ofd.yandex.net/v1/companies/693/signs
Заголовки запроса:
x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Пример запроса в формате cURL
curl -X GET \
https://api.ofd.yandex.net/v1/companies/693/signs \
-H 'x-ofd-key: eka...b17eae' \
-H 'x-yandex-key: 74f...e8ca'
Ответ:
[
{
"session_expires_at": null,
"expires_at": "2020-02-05T00:00:00+00:00",
"id": 245,
"session_started_at": null,
"is_patching": true,
"signer": {
"email": "mail@example.com",
"address": "{'addr_city': 'Москва', 'addr_postal_code': '119034', 'addr_building': '2', 'addr_region_code': 77, 'addr_street': 'ул Льва Толстого', 'addr_house': '16'}",
"name": {
"middle": "Ивановна",
"first": "Мария",
"last": "Иванова"
},
"phone": "70123456789",
"position": "Бухгалтер"
},
"company_id": 693,
"status": "inactive"
}
]