2.2 สั่งซื้อใบรับรอง

2.2.1 คำอธิบายอินเทอร์เฟซ

สภาพแวดล้อมทดสอบ
สภาพแวดล้อมจริง	https://portal.racent.com/ssl/place
วิธีการร้องขอ	POST
content-type	multipart/form-data
คำอธิบาย	อินเทอร์เฟซนี้ใช้สำหรับสั่งซื้อใบรับรอง

2.2.2 นิยามพารามิเตอร์

ชื่อพารามิเตอร์	ประเภทพารามิเตอร์	จำเป็น	คำอธิบาย
api_token	String	Y	ข้อมูลประจำตัว สำหรับการสร้าง token กรุณาติดต่อฝ่ายสนับสนุนทางเทคนิคของ 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 ขนาดไม่เกิน 2M
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 พารามิเตอร์นี้ปัจจุบันเกี่ยวข้องกับใบรับรอง Digicert SSL เท่านั้น ใช้เพื่อตัดสินว่าจะนำข้อมูลองค์กรและโดเมนที่ผ่านการตรวจสอบก่อนหน้านี้มาใช้ซ้ำหรือไม่ เมื่อค่าเป็น 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 (การยืนยันทางอีเมล) 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(การตรวจสอบทางอีเมล) HTTP_CSR_HASH(การตรวจสอบด้วยไฟล์) CNAME_CSR_HASH(การตรวจสอบด้วย DNS) HTTPS_CSR_HASH(การตรวจสอบด้วยไฟล์ https) เมื่อ dcvMethod ระดับบนไม่มีอยู่ รายการนี้จะเป็น Y เมื่อ dcvMethod ระดับบนมีอยู่และรายการนี้มีอยู่ด้วย จะใช้ dcvMethod ระดับบนเป็นลำดับแรก
dcvEmail	String	N	อีเมลสำหรับตรวจสอบโดเมน เมื่อรายการนี้เป็น 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	ข้อมูลผู้ดูแลระบบ ผู้ติดต่อ เมื่อยื่นขอ Code Signing, Email Signing หรือ Document Signing พารามิเตอร์นี้จะใช้เป็นข้อมูลคำขอ นอกจากนี้หาก 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	เมืองที่ผู้ดูแลระบบตั้งอยู่
email	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	เมืองที่พนักงานการเงินตั้งอยู่
email	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	เมืองที่เจ้าหน้าที่เทคนิคตั้งอยู่
email	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 certificate id โปรดเก็บรักษาไว้อย่างดี พารามิเตอร์นี้เป็นหลักฐานเฉพาะของอินสแตนซ์ racent
failReason	Object	N	เมื่อ Racent ยื่นคำขอใบรับรองต่อ CA ไม่สำเร็จและระบุสาเหตุความล้มเหลวได้ชัดเจน จะส่งคืนรายการนี้
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	พาธไฟล์ยืนยันโดเมน