GetCounteragentCertificates (V2)
Возвращает список сертификатов контрагента.
GET /V2/GetCounteragentCertificates
Параметры запроса
myBoxId— идентификатор ящика организации, от лица которой будет произведен поиск сертификатов контрагента, в формате GUID.counteragentBoxId— идентификатор ящика контрагента, для которого будет выполнен поиск сертификатов, в формате GUID.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у указанного ящика закончилась подписка на API.403— доступ к списку сертификатов организацииcounteragentBoxIdот организацииmyBoxIdс предоставленным авторизационным токеном запрещен.404— партнерские отношения между указанными организациями не установлены.405— используется неподходящий HTTP-метод.429— превышено ограничение на количество запросов в единицу времени.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит структуру CounteragentCertificateList:
message CounteragentCertificateList {
repeated Certificate Certificates = 1;
}
message Certificate {
required bytes RawCertificateData = 1;
}
Certificates— список сертификатов контрагента, представленных структуройCertificateс полями:RawCertificateData— сертификат, сериализованный в массив байтов в DER-кодировке.
Метод доступен только сотрудникам с доступом к ящику.
Организация может запросить список сертификатов контрагента только если у нее включена возможность отправки зашифрованных документов. Эта возможность указана в поле EncryptedDocumentsAllowed структуры Organization.Box.
Примеры использования
Пример HTTP-запроса:
GET /V2/GetCounteragentCertificates?myBoxId={{myBoxId}}&counteragentBoxId={{counteragentBoxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json
Пример тела ответа:
{
"Certificates": [
{
"RawCertificateData": "MIIIyjCCCHegAwIBAgIRAdD...Brfw=="
}
]
}
См. также
Инструкции:
Методы для работы с контрагентами:
- GetBox — по идентификатору ящика возвращает информацию об организации, которой он принадлежит
- GetCounteragent (V3) — возвращает данные контрагента по указанному идентификатору
- GetCounteragentCertificates (V2) — возвращает список сертификатов контрагента
- GetOrganization — по идентификатору организации возвращает принадлежащий ей ящик и ее данные: например, ИНН, КПП, название и т.п.
- GetOrganizationsByInnKpp — возвращает организации с указанными ИНН и КПП
- GetOrganizationsByInnList (V2) — возвращает организации и их статусы по указанному списку ИНН
Методы для работы с сертификатами:
- CanSendInvoice — позволяет узнать, может ли указанный сертификат использоваться для подписания электронных счетов-фактур
- GetCounteragentCertificates (V2) — возвращает список сертификатов контрагента
- GetMyCertificates — возвращает список сертификатов, привязанных к текущему авторизованному пользователю