2.3 Lấy trạng thái yêu cầu chứng chỉ
2.3.1 Thông tin API
| Môi trường kiểm thử | |
|---|---|
| Môi trường thực tế | https://portal.racent.com/ssl/collect |
| Phương thức yêu cầu | POST |
| content-type | multipart/form-data |
| Mô tả | Giao diện này dùng để lấy trạng thái đặt mua chứng chỉ, lấy chứng chỉ và lấy thông tin xác minh. |
2.3.2 Định nghĩa tham số
| Tên tham số | Kiểu tham số | Bắt buộc | Mô tả |
|---|---|---|---|
| certId | String | Y | ID chứng chỉ racent |
| api_token | String | Y | Thông tin xác thực định danh. Để tạo token, vui lòng liên hệ bộ phận hỗ trợ kỹ thuật của Racent. |
Giá trị trả về của hàm
| Tên tham số | Kiểu tham số | Bắt buộc | Mô tả |
|---|---|---|---|
| code | int | Y | Trạng thái trả về. Để biết chi tiết, vui lòng xem Phụ lục 3.1 |
| status | String | Y | Trạng thái đơn hàng: PENDING: Đang xử lý COMPLETE: Đăng ký thành công CANCELLED: Đã hủy REISSUED: Đã cấp lại FAILED: Đăng ký thất bại RENEWED: Đã gia hạn REVOKED: Đã thu hồi |
| certStatus | String | Y | Trạng thái chứng chỉ: PENDING: Đang xử lý COMPLETE: Đăng ký thành công CANCELLED: Đã hủy REISSUED: Đã cấp lại FAILED: Đăng ký thất bại RENEWED: Đã gia hạn REVOKED: Đã thu hồi |
| data | Object | N | Dữ liệu trả về, chi tiết cụ thể như sau |
| failReason | Object | N | Khi trạng thái là FAILED, tham số này là Y, lý do thất bại |
| dataReasons | Array | N | Lý do dữ liệu |
| key | String | N | Hạng mục |
| reason | String | N | Lý do |
| sysReason | String | N | Lý do hệ thống |
| beginDate | String | N | Khi trạng thái là COMPLETE, tham số này là Y, thời gian bắt đầu chứng chỉ |
| endDate | String | N | Khi trạng thái là COMPLETE, tham số này là Y, thời gian kết thúc chứng chỉ |
| certificate | String | N | Khi trạng thái là COMPLETE, tham số này là Y, chứng chỉ pem |
| caCertificate | String | N | Khi trạng thái là COMPLETE, tham số này là Y, chứng chỉ trung gian pem |
| jks | String | N | Khi trạng thái là COMPLETE và Racent có thông tin khóa riêng chính xác, tham số này là Y, nội dung chứng chỉ jks được mã hóa base64. |
| jksPass | String | N | Khi trạng thái là COMPLETE và Racent có thông tin khóa riêng chính xác, tham số này là Y, mật khẩu chứng chỉ jks. |
| pkcs12 | String | N | Khi trạng thái là COMPLETE và Racent có thông tin khóa riêng chính xác, tham số này là Y, nội dung chứng chỉ PKCS12 được mã hóa base64. |
| pkcsPass | String | N | Khi trạng thái là COMPLETE và Racent có thông tin khóa riêng chính xác, tham số này là Y, mật khẩu chứng chỉ PKCS12. |
| privateKey | String | N | Khi trạng thái là COMPLETE và Racent có thông tin khóa riêng chính xác, tham số này là Y, thông tin khóa riêng |
| rsaPrivateKey | String | N | Khóa riêng định dạng rsa, khi trạng thái là COMPLETE và Racent có thông tin khóa riêng chính xác, tham số này là Y, thông tin khóa riêng |
| replaceCertId | String | N | Khi trạng thái là REISSUED, tham số này là Y, id chứng chỉ Racent sau khi cấp lại |
| oldCertId | String | N | Khi chứng chỉ được yêu cầu là chứng chỉ cấp lại, tham số này là Y, id chứng chỉ Racent cũ |
| vendorId | String | N | Mã đơn hàng CA |
| vendorCertId | String | N | Số chứng chỉ CA (mã đơn hàng Sectigo) |
| DCVfileName | String | N | Xác thực tệp tên miền, tên tệp |
| DCVfileContent | String | N | Xác thực tệp, nội dung tệp |
| DCVdnsHost | String | N | Xác thực DNS, host |
| DCVdnsValue | String | N | Xác thực DNS, value |
| DCVdnsType | String | N | Xác thực DNS, type |
| dcvInfo | Object | N | Khi giá trị xác thực của từng tên miền trong đơn đăng ký chứng chỉ khác nhau, mục này là Y Mỗi mục có kiểu Object, mỗi tên đối tượng là tên miền đã đăng ký, ví dụ: racent.com. Chi tiết từng mục như sau: |
| DCVfileName | String | N | Xác thực tệp tên miền, tên tệp |
| DCVfileContent | String | N | Xác thực tệp, nội dung tệp |
| DCVdnsHost | String | N | Xác thực DNS, host |
| DCVdnsValue | String | N | Xác thực DNS, value |
| DCVdnsType | String | N | Xác thực DNS, type |
| DCVfilePath | String | N | Đường dẫn tệp xác thực tệp |
| dcvList | Array | N | Danh sách xác thực tên miền, mỗi mục có kiểu Object, chi tiết từng mục như sau: |
| domainName | String | N | Tên miền |
| dcvMethod | String | N | Phương thức xác thực tên miền |
| dcvEmail | String | N | Email xác thực tên miền |
| is_verify | String | N | Giá trị tham số đã xác minh là “verified”, nếu chưa xác minh thì không có tham số |
| application | Object | N | Trạng thái gửi đơn hàng |
| status | String | N | Tham số là một trong các giá trị sau: notdone: chưa hoàn thành done: đã hoàn thành ongoing: đang tiến hành |
| dcv | Object | N | Trạng thái xác minh tên miền |
| status | String | N | Tham số là một trong các giá trị sau: notdone: chưa hoàn thành done: đã hoàn thành ongoing: đang tiến hành |
| ov | Object | N | Trạng thái xác minh tổ chức |
| status | String | N | Tham số là một trong các giá trị sau: notdone: chưa hoàn thành done: đã hoàn thành ongoing: đang tiến hành |
| issued | Object | N | Trạng thái cấp phát |
| status | String | N | Tham số là một trong các giá trị sau: notdone: chưa hoàn thành done: đã hoàn thành ongoing: đang tiến hành |
| applyParams | Object | N | Tham số yêu cầu, vui lòng tham khảo tham số yêu cầu của giao diện đăng ký (place) |
| csr | String | N | csr |
| Administrator | Object | N | Thông tin quản trị viên |
| job | String | N | Chức vụ |
| city | String | N | Thành phố |
| String | N | ||
| state | String | N | Tỉnh hoặc bang |
| mobile | String | N | Phương thức liên hệ |
| address | String | N | Địa chỉ liên hệ |
| country | String | N | Quốc gia (mã hai chữ cái theo tiêu chuẩn ISO 3166-1). |
| lastName | String | N | Họ |
| postCode | String | N | Mã bưu chính |
| firstName | String | N | Tên |
| organation | String | N | Tên công ty |
| idType | String | N | Loại giấy tờ. Đối với CFCA, mục này là Y. Các giá trị như sau: SFZ: Chứng minh nhân dân HZ: Hộ chiếu |
| idNumber | String | N | Số giấy tờ. Đối với CFCA, mục này là Y. |
| tech | Object | N | Thông tin kỹ thuật viên, các mục cụ thể giống với thông tin quản trị viên |
| finance | Object | N | Thông tin nhân viên tài chính, các mục cụ thể giống với thông tin quản trị viên |
| organizationInfo | Object | N | Thông tin công ty |
| organizationCity | String | N | Thành phố |
| organizationName | String | N | Tên |
| organizationMobile | String | N | Điện thoại |
| organizationAddress | String | N | Địa chỉ |
| organizationCountry | String | N | Quốc gia |
| organizationPostCode | String | N | Mã bưu chính |
| organizationRegNumbe | String | N | Số giấy chứng nhận công ty. Mục này là Y đối với CFCA. |
| idType | String | N | Loại giấy chứng nhận công ty. Mục này là Y đối với CFCA. Giá trị như sau: TYDMZ: Mã thống nhất tín dụng xã hội OTHERS: Khác |
| errors | Object hoặc String | N | Khi trạng thái trả về là lỗi, đây là thông tin lỗi cụ thể. |