2.3 รับสถานะการขอใบรับรอง
2.3.1 ข้อมูล Api
| สภาพแวดล้อมทดสอบ | |
|---|---|
| สภาพแวดล้อมจริง | https://portal.racent.com/ssl/collect |
| วิธีการร้องขอ | POST |
| content-type | multipart/form-data |
| คำอธิบาย | อินเทอร์เฟซนี้ใช้สำหรับตรวจสอบสถานะคำสั่งซื้อใบรับรอง รับใบรับรอง และรับข้อมูลการยืนยัน |
2.3.2 นิยามพารามิเตอร์
| ชื่อพารามิเตอร์ | ประเภทพารามิเตอร์ | จำเป็น | คำอธิบาย |
|---|---|---|---|
| certId | String | Y | racent certificate id |
| api_token | String | Y | ข้อมูลประจำตัว โปรดติดต่อฝ่ายสนับสนุนทางเทคนิคของ Racent เพื่อสร้าง token |
การส่งคืนของฟังก์ชัน
| ชื่อพารามิเตอร์ | ประเภทพารามิเตอร์ | จำเป็น | คำอธิบาย |
|---|---|---|---|
| code | int | Y | สถานะการส่งคืน โปรดดูรายละเอียดเพิ่มเติมในภาคผนวก 3.1 |
| status | String | Y | สถานะคำสั่งซื้อ: PENDING:กำลังดำเนินการ COMPLETE:สำเร็จ CANCELLED:ยกเลิกแล้ว REISSUED:ออกใหม่แล้ว FAILED:ล้มเหลว RENEWED:ต่ออายุแล้ว REVOKED:เพิกถอนแล้ว |
| certStatus | String | Y | สถานะใบรับรอง: PENDING:กำลังดำเนินการ COMPLETE:สำเร็จ CANCELLED:ยกเลิกแล้ว REISSUED:ออกใหม่แล้ว FAILED:ล้มเหลว RENEWED:ต่ออายุแล้ว REVOKED:เพิกถอนแล้ว |
| data | Object | N | ข้อมูลที่ส่งกลับ, รายละเอียดเฉพาะดังต่อไปนี้ |
| failReason | Object | N | เมื่อสถานะเป็น FAILED พารามิเตอร์นี้คือ Y, สาเหตุความล้มเหลว |
| dataReasons | Array | N | เหตุผลของข้อมูล |
| key | String | N | รายการ |
| reason | String | N | เหตุผล |
| sysReason | String | N | เหตุผลจากระบบ |
| beginDate | String | N | เมื่อสถานะเป็น COMPLETE พารามิเตอร์นี้คือ Y, เวลาเริ่มต้นของใบรับรอง |
| endDate | String | N | เมื่อสถานะเป็น COMPLETE พารามิเตอร์นี้คือ Y, เวลาสิ้นสุดของใบรับรอง |
| certificate | String | N | เมื่อสถานะเป็น COMPLETE พารามิเตอร์นี้คือ Y, ใบรับรอง pem |
| caCertificate | String | N | เมื่อสถานะเป็น COMPLETE พารามิเตอร์นี้คือ Y, pem intermediate certificate |
| jks | String | N | เมื่อสถานะเป็น COMPLETE และ Racent มีข้อมูล private key ที่ถูกต้อง พารามิเตอร์นี้คือ Y, เนื้อหาใบรับรอง jks ที่เข้ารหัส base64 |
| jksPass | String | N | เมื่อสถานะเป็น COMPLETE และ Racent มีข้อมูล private key ที่ถูกต้อง พารามิเตอร์นี้คือ Y, รหัสผ่านใบรับรอง jks |
| pkcs12 | String | N | เมื่อสถานะเป็น COMPLETE และ Racent มีข้อมูล private key ที่ถูกต้อง พารามิเตอร์นี้คือ Y, เนื้อหาใบรับรอง PKCS12 ที่เข้ารหัส base64 |
| pkcsPass | String | N | เมื่อสถานะเป็น COMPLETE และ Racent มีข้อมูล private key ที่ถูกต้อง พารามิเตอร์นี้คือ Y, รหัสผ่านใบรับรอง PKCS12 |
| privateKey | String | N | เมื่อสถานะเป็น COMPLETE และ Racent มีข้อมูล private key ที่ถูกต้อง พารามิเตอร์นี้คือ Y, ข้อมูล private key |
| rsaPrivateKey | String | N | private key รูปแบบ rsa เมื่อสถานะเป็น COMPLETE และ Racent มีข้อมูล private key ที่ถูกต้อง พารามิเตอร์นี้คือ Y, ข้อมูล private key |
| replaceCertId | String | N | เมื่อสถานะเป็น REISSUED พารามิเตอร์นี้คือ Y, รหัสใบรับรอง Racent หลังการออกใบรับรองใหม่ |
| oldCertId | String | N | เมื่อใบรับรองที่ยื่นคำขอเป็นใบรับรองที่ออกใหม่ พารามิเตอร์นี้คือ Y, รหัสใบรับรอง Racent เดิม |
| vendorId | String | N | หมายเลขคำสั่งซื้อ CA |
| vendorCertId | String | N | หมายเลขใบรับรอง CA (หมายเลขคำสั่งซื้อ Sectigo) |
| DCVfileName | String | N | การตรวจสอบไฟล์โดเมน ชื่อไฟล์ |
| DCVfileContent | String | N | การตรวจสอบไฟล์ เนื้อหาไฟล์ |
| DCVdnsHost | String | N | การตรวจสอบ DNS, host |
| DCVdnsValue | String | N | การตรวจสอบ DNS, value |
| DCVdnsType | String | N | การตรวจสอบ DNS, type |
| dcvInfo | Object | N | เมื่อค่าการตรวจสอบของแต่ละโดเมนในคำขอใบรับรองไม่เหมือนกัน รายการนี้เป็น Y แต่ละรายการเป็นชนิด Object ชื่อออบเจกต์แต่ละรายการคือโดเมนที่ยื่นขอ เช่น racent.com รายละเอียดแต่ละรายการดังนี้: |
| DCVfileName | String | N | การตรวจสอบไฟล์โดเมน ชื่อไฟล์ |
| DCVfileContent | String | N | การตรวจสอบด้วยไฟล์ เนื้อหาไฟล์ |
| DCVdnsHost | String | N | การตรวจสอบ DNS, host |
| DCVdnsValue | String | N | การตรวจสอบ DNS, value |
| DCVdnsType | String | N | การตรวจสอบ DNS, type |
| DCVfilePath | String | N | เส้นทางไฟล์สำหรับการตรวจสอบด้วยไฟล์ |
| dcvList | Array | N | รายการตรวจสอบโดเมน แต่ละรายการเป็นชนิด Object รายละเอียดแต่ละรายการดังนี้: |
| domainName | String | N | ชื่อโดเมน |
| dcvMethod | String | N | วิธีการตรวจสอบโดเมน |
| dcvEmail | String | N | อีเมลสำหรับตรวจสอบโดเมน |
| is_verify | String | N | ค่าพารามิเตอร์ที่ตรวจสอบแล้วคือ “verified” หากยังไม่ตรวจสอบจะไม่มีพารามิเตอร์ |
| application | Object | N | สถานะการส่งคำสั่งซื้อ |
| status | String | N | พารามิเตอร์เป็นค่าใดค่าหนึ่งต่อไปนี้: notdone:ยังไม่เสร็จสิ้น done:เสร็จสิ้นแล้ว ongoing:กำลังดำเนินการ |
| dcv | Object | N | สถานะการตรวจสอบโดเมน |
| status | String | N | พารามิเตอร์เป็นค่าใดค่าหนึ่งต่อไปนี้: notdone:ยังไม่เสร็จสิ้น done:เสร็จสิ้นแล้ว ongoing:กำลังดำเนินการ |
| ov | Object | N | สถานะการตรวจสอบองค์กร |
| status | String | N | พารามิเตอร์เป็นค่าใดค่าหนึ่งต่อไปนี้: notdone:ยังไม่เสร็จสิ้น done:เสร็จสิ้นแล้ว ongoing:กำลังดำเนินการ |
| issued | Object | N | สถานะการออกใบรับรอง |
| status | String | N | พารามิเตอร์เป็นค่าใดค่าหนึ่งต่อไปนี้: notdone:ยังไม่เสร็จสิ้น done:เสร็จสิ้นแล้ว ongoing:กำลังดำเนินการ |
| applyParams | Object | N | พารามิเตอร์การสมัคร โปรดดูรายละเอียดพารามิเตอร์คำขอของอินเทอร์เฟซการสมัคร (place) |
| csr | String | N | csr |
| Administrator | Object | N | ข้อมูลผู้ดูแลระบบ |
| 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 | Object | N | ข้อมูลเจ้าหน้าที่เทคนิค รายละเอียดย่อยเหมือนกับข้อมูลผู้ดูแลระบบ |
| finance | Object | N | ข้อมูลเจ้าหน้าที่การเงิน รายละเอียดย่อยเหมือนกับข้อมูลผู้ดูแลระบบ |
| organizationInfo | Object | N | ข้อมูลบริษัท |
| organizationCity | String | N | เมือง |
| organizationName | String | N | ชื่อ |
| organizationMobile | String | N | โทรศัพท์ |
| organizationAddress | String | N | ที่อยู่ |
| organizationCountry | String | N | ประเทศ |
| organizationPostCode | String | N | รหัสไปรษณีย์ |
| organizationRegNumbe | String | N | หมายเลขเอกสารบริษัท รายการนี้เป็น Y สำหรับ CFCA |
| idType | String | N | ประเภทเอกสารบริษัท รายการนี้เป็น Y สำหรับ CFCA ค่าดังนี้: TYDMZ: รหัสเครดิตสังคมรวม OTHERS: อื่นๆ |
| errors | Object หรือ String | N | เมื่อสถานะที่ส่งกลับเป็นข้อผิดพลาด ข้อมูลข้อผิดพลาดโดยละเอียด |