2.2 Заказ сертификата
2.2.1 Описание интерфейса
| Тестовая среда | |
|---|---|
| Рабочая среда | https://portal.racent.com/ssl/place |
| Метод запроса | POST |
| content-type | multipart/form-data |
| Описание | Этот интерфейс используется для заказа сертификатов. |
2.2.2 Определение параметров
| Название параметра | Тип параметра | Обязательный | Описание |
|---|---|---|---|
| api_token | String | Y | Учётные данные, для генерации токена обратитесь в техническую поддержку Racent. |
| productCode | String | Y | Код продукта, получение кода продукта (см. 2.7) |
| years | Int | Y | Срок покупки (в настоящее время поддерживаются только 1, 2, 3, 4, 5), в зависимости от конкретного продукта. |
| refId | String | N | Уникальный номер заказа клиента, предоставленный клиентом |
| verificationPic | File | N | Резервные материалы для проверки. Используются для проверки организации, поддерживаются форматы .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf, размер не более 2 МБ. |
| domainVerificationPic | File | N | Если способ проверки домена — VERIFY_DOCUMENT, этот параметр обязателен (Y). Используется для подтверждения права собственности на домен (в настоящее время поддерживается только CFCA). |
| params | String | Y | Информация о заказе, подробное описание приведено ниже |
| csr | String | N | Если параметр пуст, для вас будет сгенерирован CSR, а закрытый ключ сохранён. |
| privateKey | String | N | Закрытый ключ. |
| server | String | N | Сервер. Относится только к SSL-сертификатам. Для SSL-сертификатов этот параметр — Y, для продуктов других типов — N. Если этот параметр не нужен, по умолчанию укажите «other». |
| orgCheck | Int | N | Значение 0 или 1. При значении 1 будет выполнен поиск всех организаций в вашей учетной записи на основе предоставленной информации об организации. Если организация существует, будут использованы связанные с ней данные; если не существует, мы сохраним её как новую организацию. При значении 0 информация об организации не сохраняется. |
| duplicateOrgCheck | Int | N | Значение 0 или 1. В настоящее время этот параметр относится только к SSL-сертификатам Digicert. Используется для определения необходимости повторного использования ранее проверенной информации об организации и домене. При значении 1 — повторное использование. При значении 0 — создание новой. По умолчанию 1. |
| needFree | Int | N | Значение 1 или 2. При значении 1 будет предоставлен FQDN, а для www.domain также будет предоставлен domain. При значении 2 — не предоставляется. |
| uniqueValue | String | N | Только для продуктов Sectigo. 1–20 символов (a–z A–Z 0–9) для самостоятельной генерации проверочного значения дистрибьютором. |
| dcvMethod | String | N | Единая настройка способа проверки домена при подаче заявки. Должен быть одним из четырёх следующих способов: EMAIL (проверка по email) HTTP_CSR_HASH (проверка по файлу) CNAME_CSR_HASH (проверка по DNS) HTTPS_CSR_HASH (проверка по https-файлу) VERIFY_DOCUMENT (подтверждение сертификатом домена, поддерживается только CFCA) Для CFCA этот параметр — Y |
| domainInfo | String | N | Информация о домене, относится только к SSL-сертификатам. Для параметров SSL-сертификата — Y, для параметров других типов — N. Пример: [ { "dcvEmail": "admin@xxx.com", "dcvMethod": "EMAIL", "domainName": "www.xxx.com" }, { "dcvEmail": "admin@aaa.com", "dcvMethod": "EMAIL", "domainName": "aaa.com" }, "dcvEmail": "admin@racent.com", "dcvMethod": "EMAIL", "domainName": "racent.com" } ] Подробное описание приведено ниже: |
| dcvMethod | String | N | Способ проверки домена. Должен быть одним из четырёх: EMAIL(проверка по email) HTTP_CSR_HASH(проверка файлом) CNAME_CSR_HASH(проверка DNS) HTTPS_CSR_HASH(проверка https-файлом) Если dcvMethod верхнего уровня отсутствует, это поле обязательно (Y). Если dcvMethod верхнего уровня существует и это поле также задано, приоритет будет у dcvMethod верхнего уровня |
| dcvEmail | String | N | Email для проверки домена. Если это поле не задано (N), значения по умолчанию следующие: racent.com : admin@racent.com www.racent.com : admin@racent.com *.racent.com : admin@racent.com |
| domainName | String | N | Домен |
| organizationInfo | String | N | Информация о компании. При заказе продуктов, требующих корпоративной верификации, этот параметр — Y. Пример: { "organizationCity": "上海", "organizationName": "某公司", "organizationMobile": "18111111111", "organizationAddress": "上海市路", "organizationCountry": "CN", "organizationPostCode": "401320" }" |
| organizationCity | String | N | Город, в котором находится компания. |
| organizationName | String | N | Название компании. |
| organizationMobile | String | N | Телефон компании. |
| organizationAddress | String | N | Адрес компании. |
| organizationCountry | String | N | Страна, в которой находится компания (двухбуквенный код в соответствии со стандартом ISO 3166-1). |
| organizationPostCode | String | N | Почтовый индекс местоположения компании. |
| organizationRegNumbe | String | N | Номер свидетельства компании. Для CFCA это поле — Y. |
| idType | String | N | Тип документа компании. Для CFCA это поле — Y. Значения: TYDMZ: единый код социального кредита OTHERS: другое |
| Administrator | string | Y | Информация об администраторе и контактном лице. При запросе подписи кода, подписи электронной почты или подписи документа этот параметр используется как информация запроса. Кроме того, если csr — N, эта информация используется для генерации csr. { "job": "总经办", "city": "上海市", "email": "xx@yy.com", "state": "上海市", "mobile": "18111111111", "address": "上海市", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" |
| job | String | Y | Должность администратора. |
| city | String | Y | Город администратора. |
| String | Y | Электронная почта администратора. | |
| state | String | Y | Администратор в провинции или штате. |
| mobile | String | Y | Контактный телефон администратора. |
| address | String | Y | Контактный адрес администратора. |
| country | String | Y | Страна администратора (двухбуквенный код по стандарту ISO 3166-1). |
| lastName | String | Y | Фамилия администратора. |
| postCode | String | Y | Почтовый индекс администратора. |
| firstName | String | Y | Имя администратора. |
| organation | String | Y | Название компании администратора. |
| idType | String | N | Тип документа. Для CFCA это поле обязательно (Y). |
| idNumber | String | N | Номер удостоверения личности. Для CFCA это поле — Y. |
| finance | string | Относится только к SSL-сертификатам. Информация о финансовом сотруднике. Может совпадать с информацией администратора. При заказе продукта не типа dv этот параметр — Y. { "job": "财务部", "city": "上海市", "email": "xx@yy.com", "state": "上海市", "mobile": "18111111111", "address": "上海市", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" | |
| job | String | N | Должность финансового сотрудника. |
| city | String | N | Город, в котором находится финансовый сотрудник. |
| String | N | Электронная почта финансового сотрудника. | |
| state | String | N | Провинция или штат, в котором находится финансовый сотрудник. |
| mobile | String | N | Контактный номер финансового менеджера. |
| address | String | N | Контактный адрес финансового менеджера. |
| country | String | N | Страна финансового менеджера (двухбуквенный код по стандарту ISO 3166-1). |
| lastName | String | N | Фамилия финансового сотрудника. |
| postCode | String | N | Почтовый индекс местонахождения финансового сотрудника. |
| firstName | String | N | Имя финансового сотрудника. |
| organation | String | N | Компания, в которой работает финансовый сотрудник. |
| idType | String | N | Тип удостоверения личности. Для CFCA это поле — Y. Значения: SFZ：удостоверение личности HZ：паспорт |
| idNumber | String | N | Номер удостоверения личности. Для CFCA это поле — Y. |
| tech | string | N | Только для SSL-сертификатов. Информация о техническом специалисте. Если заказываемый продукт не относится к типу dv, этот параметр обязателен (Y). { "job": "技术部","city": "上海市", "email": "xx@yy.com", "state": "上海市", "mobile": "18111111111", "address": "上海市", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" |
| job | String | N | Должность технического специалиста. |
| city | String | N | Город технического специалиста. |
| String | N | Электронная почта технического специалиста. | |
| state | String | N | Провинция или штат, где находится технический специалист. |
| mobile | String | N | Контактный номер технического специалиста. |
| address | String | N | Контактный адрес технического специалиста. |
| country | String | N | Страна технического специалиста (двухбуквенный код по стандарту ISO 3166-1). |
| lastName | String | N | Фамилия технического специалиста. |
| postCode | String | N | Почтовый индекс местонахождения технического специалиста. |
| firstName | String | N | Имя технического специалиста. |
| organation | String | N | Компания, в которой работает технический специалист. |
| idType | String | N | Тип удостоверения личности. Для CFCA это поле — Y. Возможные значения: SFZ: удостоверение личности HZ: паспорт |
| idNumber | String | N | Номер удостоверения личности. Для CFCA это поле — Y. |
Возвращаемое значение функции
| Название параметра | Тип параметра | Обязательный | Описание |
|---|---|---|---|
| code | Int | Y | Статус возврата. Подробнее см. в Приложении 3.1 |
| errors | Object or String | N | При ошибке возврата содержит конкретное сообщение об ошибке. |
| data | Object | N | При успешном возврате это поле — Y. Описание ниже: |
| certId | String | N | Идентификатор сертификата racent. Храните его надёжно: это уникальный идентификатор экземпляра racent. |
| failReason | Object | N | Возвращается, если запрос сертификата в CA от имени Racent завершился неудачей и причина ошибки установлена. |
| dataReasons | Array | N | Причины данных |
| key | String | N | Элемент |
| reason | String | N | Причина |
| sysReason | String | N | Системная причина |
| vendorId | String | N | Номер заказа CA. |
| vendorCertId | String | N | Номер сертификата CA. |
| DCVfileName | String | N | Имя файла для проверки файла |
| DCVfileContent | String | N | Содержимое файла для проверки файла |
| DCVdnsHost | String | N | Значение хоста для проверки DNS |
| DCVdnsValue | String | N | Значение записи для проверки DNS |
| DCVdnsType | String | N | Тип записи для проверки DNS |
| DCVfilePath | String | N | Путь к файлу для проверки файла |
| dcvInfo | Object | N | Если значения проверки для каждого домена в заявке на сертификат различаются, этот параметр — Y Каждый элемент имеет тип Object, имя каждого объекта — запрашиваемый домен, например: racent.com. Подробности по каждому элементу приведены ниже: |
| DCVfileName | String | N | Содержимое файла для проверки файла |
| DCVfileContent | String | N | Содержимое файла для проверки файла |
| DCVdnsHost | String | N | Значение хоста для проверки DNS |
| DCVdnsValue | String | N | Значение записи для проверки DNS |
| DCVdnsType | String | N | Тип записи для проверки DNS |
| DCVfilePath | String | N | Путь к файлу для проверки файла |