GetCounteragentCertificates
Предупреждение
Эта версия метода устарела. Используйте новую версию метода GetCounteragentCertificates (V2).
Метод GetCounteragentCertificates возвращает сертификаты контрагента.
- GET /GetCounteragentCertificates
- Query Parameters:
myOrgId – идентификатор организации, от лица которой будет произведен поиск сертификатов контрагента.
counteragentOrgId – идентификатор организации, у которой осуществляется поиск сертификатов контрагента.
- Request Headers:
Authorization – данные, необходимые для авторизации.
- Status Codes:
200 OK – операция успешно завершена.
400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
401 Unauthorized – в запросе отсутствует HTTP-заголовок
Authorizationили в этом заголовке содержатся некорректные авторизационные данные.402 Payment Required – у организации с указанным идентификатором
myOrgIdзакончилась подписка на API.403 Forbidden – доступ к списку сертификатов организации
counteragentOrgIdот организацииmyOrgIdс предоставленным авторизационным токеном запрещен.404 Not Found – партнерские отношения между организациями
myOrgIdиcounteragentOrgIdне установлены.405 Method Not Allowed – используется неподходящий HTTP-метод.
500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.
- Response Body:
Тело ответа содержит структуру
CounteragentCertificateList:message CounteragentCertificateList { repeated Certificate Certificates = 1; } message Certificate { required bytes RawCertificateData = 1; }
Certificates— список сертификатов контрагента. Каждый элемент списка представлен структуройCertificateс полями:RawCertificateData— сертификат, сериализованный в массив байтов в DER-кодировке.
Метод доступен только сотрудникам с доступом к ящику.
Организация имеет право запрашивать список сертификатов контрагента counteragentOrgId, если у нее включена возможность отправки зашифрованных документов. Эта возможность указана в поле Organization.Box.EncryptedDocumentsAllowed.