跳至主要内容

2.2 訂購證書

2.2.1 介面說明

測試環境
真實環境https://portal.racent.com/ssl/place
請求方式POST
content-typemultipart/form-data
描述此介面用於訂購證書。

2.2.2 參數定義

參數名稱參數類型必填說明
api_tokenStringY身份憑據,生成 token 請聯絡 Racent 技術支援。
productCodeStringY產品編碼,取得產品編碼(見2.7)
yearsIntY購買年限(目前僅支援1、2、3、4、5),依具體產品而定。
refIdStringN客戶提供的唯一客戶訂單編號
verificationPicFileN備用驗證材料。用於組織驗證,支援 .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf 格式,內容大小不超過 2M。
domainVerificationPicFileN當網域驗證方式為:VERIFY_DOCUMENT 時,此項為 Y。用於網域控制權驗證(DCV)(目前僅支援 CFCA)。
paramsStringY訂購資訊,具體說明如下
csrStringN當參數為空時,會為你生成 CSR 並儲存私密金鑰。
privateKeyStringN私密金鑰。
serverStringN伺服器。僅與 SSL 憑證相關。SSL 憑證參數為 Y,其他類型產品參數為 N。若不需要此參數,請預設為「other」。
orgCheckIntN值為 0 或 1。當值為 1 時,將根據你提交的組織資訊檢索你帳號下的所有組織,若存在則使用存在組織的關聯資訊,若不存在我們將其儲存為新的組織。當值為 0 時,不儲存組織資訊。
duplicateOrgCheckIntN值為 0 或 1。該參數目前僅與 Digicert SSL 證書相關。用於判斷是否複用先前驗證通過的組織和網域資訊。當值為 1 時,複用。當值為 0 時,新建。預設為 1。
needFreeIntN值為 1 或 2。當值為 1 時,將贈送 FQDN,同時 www.domain 也將贈送 domain。值為 2 時,不贈送。
uniqueValueStringN僅與 Sectigo 產品相關。1-20 個字元(a-z A-Z 0-9),供經銷商自行產生驗證值使用。
dcvMethodStringN統一設定申請網域的驗證方式。
必須為以下五種方式之一:
EMAIL(電子郵件驗證)
HTTP_CSR_HASH(檔案驗證)
CNAME_CSR_HASH(DNS 驗證)
HTTPS_CSR_HASH(https 檔案驗證)
VERIFY_DOCUMENT(網域證書證明,僅支援 CFCA)
CFCA 此項為 Y
domainInfoStringN網域資訊,僅與 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"
}
]
具體說明如下:
dcvMethodStringN網域驗證方式。
必須為以下四種方式之一:
EMAIL(郵箱驗證)
HTTP_CSR_HASH(檔案驗證)
CNAME_CSR_HASH(DNS驗證)
HTTPS_CSR_HASH(https檔案驗證)
當上層dcvMethod不存在時,此項為Y。
當上層dcvMethod存在,該項也存在,會優先使用上層dcvMethod
dcvEmailStringN網域驗證信箱。
該項為N時,預設情況如下
racent.com : admin@racent.com
www.racent.com : admin@racent.com
*.racent.com : admin@racent.com
domainNameStringN網域名稱
organizationInfoStringN公司資訊。當訂購需企業驗證類產品時,此參數為 Y。範例如下:
{
"organizationCity": "上海",
"organizationName": "某公司",
"organizationMobile": "18111111111",
"organizationAddress": "上海市路",
"organizationCountry": "CN",
"organizationPostCode": "401320"
}"
organizationCityStringN公司所在城市。
organizationNameStringN公司名稱。
organizationMobileStringN公司電話。
organizationAddressStringN公司地址。
organizationCountryStringN公司所在國家(ISO 3166-1 標準中的雙字母代碼)。
organizationPostCodeStringN公司所在地郵遞區號。
organizationRegNumbeStringN公司證件號碼。CFCA此項為Y。
idTypeStringN公司證件類型。CFCA此項為Y。
值如下:
TYDMZ:統一社會信用代碼
OTHERS:其他
AdministratorstringY管理員資訊、聯絡人。申請程式碼簽章、郵件簽章、文件簽章時,此參數作為申請資訊。另外若csr為N,該資訊作為csr的生成資訊。
{
"job": "總經辦",
"city": "上海市",
"email": "xx@yy.com",
"state": "上海市",
"mobile": "18111111111",
"address": "上海市",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "某公司"
}"
jobStringY管理員職位。
cityStringY管理員所在城市。
emailStringY管理員的電子郵件。
stateStringY管理員所在省或州。
mobileStringY管理員聯絡方式。
addressStringY管理員聯絡地址。
countryStringY管理員所在國家(ISO 3166-1 標準中的雙字母代碼)。
lastNameStringY管理員姓氏。
postCodeStringY管理員所在地郵遞區號。
firstNameStringY管理員名字。
organationStringY管理員公司名稱。
idTypeStringN證件類型。CFCA此項為Y。
idNumberStringN證件號碼。CFCA 此項為 Y。
financestring僅與 SSL 憑證相關。
財務人員資訊。可與管理員資訊一致。當訂購產品非 dv 類型時,此參數為 Y。
{
"job": "財務部",
"city": "上海市",
"email": "xx@yy.com",
"state": "上海市",
"mobile": "18111111111",
"address": "上海市",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "某公司"
}"
jobStringN財務人員職位。
cityStringN財務員所在城市。
emailStringN財務員的信箱。
stateStringN財務員所在省或州。
mobileStringN財務員聯絡方式。
addressStringN財務員聯絡地址。
countryStringN財務員所在國家(ISO 3166-1 標準中的雙字母代碼)。
lastNameStringN財務員姓。
postCodeStringN財務員所在地郵遞區號。
firstNameStringN財務員名字。
organationStringN財務員所在公司。
idTypeStringN證件類型。CFCA此項為Y。
值如下:
SFZ:身分證
HZ:護照
idNumberStringN證件號碼。CFCA此項為Y。
techstringN僅與SSL證書相關。
技術員資訊。當訂購產品非dv類型時,此參數為Y。
{
"job": "技術部","city": "上海市",
"email": "xx@yy.com",
"state": "上海市",
"mobile": "18111111111",
"address": "上海市",
"country": "CN",
"lastName": "zhang",
"postCode": "401320",
"firstName": "nick",
"organation": "某公司"
}"
jobStringN技術員職位。
cityStringN技術員所在城市。
emailStringN技術員的電子郵件。
stateStringN技術員所在省或州。
mobileStringN技術員聯絡方式。
addressStringN技術員聯絡地址。
countryStringN技術員所在國家(ISO 3166-1 標準中的雙字母代碼)。
lastNameStringN技術員姓氏。
postCodeStringN技術員所在地郵遞區號。
firstNameStringN技術員名字。
organationStringN技術員所在公司。
idTypeStringN證件類型。CFCA此項為Y。
值如下:
SFZ:身份證
HZ:護照
idNumberStringN證件號碼。CFCA此項為Y。

函式回傳

參數名稱參數類型必填說明
codeIntY回傳狀態,具體詳解請參見附錄3.1
errorsObject or StringN當回傳狀態為錯誤時,具體錯誤資訊。
dataObjectN當回傳狀態為成功時,此參數為Y。具體描述如下:
certIdStringNracent證書id。請妥善保管,此參數為racent實例唯一憑據。
failReasonObjectN當銳成向CA申請證書失敗,並能明確了失敗原因,會回傳此項。
dataReasonsArrayN資料原因
keyStringN項目
reasonStringN原因
sysReasonStringN系統原因
vendorIdStringNCA訂單號。
vendorCertIdStringNCA憑證號。
DCVfileNameStringN檔案驗證檔名
DCVfileContentStringN檔案驗證檔案內容
DCVdnsHostStringNDNS驗證主機值
DCVdnsValueStringNDNS驗證記錄值
DCVdnsTypeStringNDNS驗證記錄類型
DCVfilePathStringN檔案驗證檔案路徑
dcvInfoObjectN申請憑證中的每個網域驗證值不一樣時,此項為Y
每項類型為Object,每項對象名為申請的網域,如:racent.com。每項詳情如下:
DCVfileNameStringN檔案驗證檔案內容
DCVfileContentStringN檔案驗證檔案內容
DCVdnsHostStringNDNS 驗證主機值
DCVdnsValueStringNDNS 驗證記錄值
DCVdnsTypeStringNDNS 驗證記錄類型
DCVfilePathStringN檔案驗證檔案路徑