GetCounteragentCertificates
warning
Метод устарел и будет удален из API после 10 ноября 2026 года. Подробнее в истории изменений. Используйте актуальную версию метода — GetCounteragentCertificates (V2).
Метод GetCounteragentCertificates возвращает сертификаты контрагента.
GET /GetCounteragentCertificates
Параметры запроса
myOrgId— идентификатор организации, от лица которой будет произведен поиск сертификатов контрагента.counteragentOrgId— идентификатор организации, у которой осуществляется поиск сертификатов контрагента.
Заголовки запроса
Authorization— данные, необходимые для авторизации.
Коды ответа
200— операция успешно завершена.400— данные в запросе имеют неверный формат или отсутствуют обязательные параметры.401— в запросе отсутствует HTTP-заголовокAuthorizationили в этом заголовке содержатся некорректные авторизационные данные.402— у организации с указанным идентификаторомmyOrgIdзакончилась подписка на API.403— доступ к списку сертификатов организацииcounteragentOrgIdот организацииmyOrgIdс предоставленным авторизационным токеном запрещен.404— партнерские отношения между организациямиmyOrgIdиcounteragentOrgIdне установлены.405— используется неподходящий HTTP-метод.500— при обработке запроса возникла непредвиденная ошибка.
Тело ответа
Тело ответа содержит структуру CounteragentCertificateList:
message CounteragentCertificateList {
repeated Certificate Certificates = 1;
}
message Certificate {
required bytes RawCertificateData = 1;
}
Certificates— список сертификатов контрагента. Каждый элемент списка представлен структуройCertificateс полями:RawCertificateData— сертификат, сериализованный в массив байтов в DER-кодировке.
Метод доступен только сотрудникам с доступом к ящику.
Организация имеет право запрашивать список сертификатов контрагента counteragentOrgId, если у нее включена возможность отправки зашифрованных документов. Эта возможность указана в поле Organization.Box.EncryptedDocumentsAllowed.