2.21 แก้ไขเอกสารคำขอ
2.21.1 ข้อมูล API
| สภาพแวดล้อมทดสอบ | |
|---|---|
| สภาพแวดล้อมจริง | https://portal.racent.com/ssl/alter |
| เมธอดคำขอ | POST |
| content-type | multipart/form-data |
| คำอธิบาย | อินเทอร์เฟซนี้ใช้เฉพาะเมื่อการยื่นขอใบรับรอง CFCA ล้มเหลว เพื่อแก้ไขข้อมูลการยื่นขอ |
2.21.2 นิยามพารามิเตอร์
| ชื่อพารามิเตอร์ | ประเภทพารามิเตอร์ | บังคับ | คำอธิบาย |
|---|---|---|---|
| api_token | String | Y | ข้อมูลประจำตัว สำหรับการสร้าง token กรุณาติดต่อฝ่ายสนับสนุนทางเทคนิคของ Racent |
| certId | String | Y | รหัสใบรับรอง racent |
| refId | String | N | หมายเลขคำสั่งซื้อเฉพาะของลูกค้าที่ลูกค้าเป็นผู้ให้ |
| verificationPic | File | N | เอกสารยืนยันสำรอง ใช้สำหรับการยืนยันองค์กร รองรับรูปแบบ .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip ขนาดไม่เกิน 2M |
| domainVerificationPic | File | N | เมื่อวิธีการยืนยันโดเมนคือ: VERIFY_DOCUMENT รายการนี้จะเป็น Y ใช้สำหรับการยืนยันความเป็นเจ้าของโดเมน (ปัจจุบันรองรับเฉพาะ CFCA) |
| params | String | Y | ข้อมูลการสั่งซื้อ รายละเอียดอธิบายดังนี้ |
| csr | String | N | เมื่อพารามิเตอร์ว่าง จะสร้าง csr ให้คุณและบันทึก private key |
| privateKey | String | N | Private key |
| 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 |
| 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 | เมืองที่ผู้ดูแลระบบตั้งอยู่ |
| 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 ค่ามีดังนี้: SFZ: บัตรประจำตัวประชาชน HZ: หนังสือเดินทาง |
| 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 หรือ String | N | เมื่อสถานะที่ส่งกลับเป็นข้อผิดพลาด ข้อมูลข้อผิดพลาดเฉพาะ |
| data | Object | N | เมื่อสถานะที่ส่งกลับเป็นความสำเร็จ พารามิเตอร์นี้คือ Y คำอธิบายเฉพาะดังนี้: |
| certId | String | N | รหัสใบรับรอง racent โปรดเก็บรักษาไว้อย่างดี พารามิเตอร์นี้เป็นข้อมูลประจำตัวเพียงหนึ่งเดียวของอินสแตนซ์ racent |
| 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 | เส้นทางไฟล์สำหรับการตรวจสอบไฟล์ |
| failReason | Object | N | เมื่อ Racent ยื่นขอใบรับรองกับ CA ไม่สำเร็จและระบุสาเหตุความล้มเหลวได้ชัดเจน รายการนี้จะถูกส่งกลับ |
| dataReasons | Array | N | สาเหตุจากข้อมูล |
| key | String | N | รายการ |
| reason | String | N | สาเหตุ |
| sysReason | String | N | สาเหตุจากระบบ |