2.2 Đặt mua chứng chỉ
2.2.1 Mô tả API
| Môi trường kiểm thử | |
|---|---|
| Môi trường thực tế | https://portal.racent.com/ssl/place |
| Phương thức yêu cầu | POST |
| content-type | multipart/form-data |
| Mô tả | API này dùng để đặt mua chứng chỉ. |
2.2.2 Định nghĩa tham số
| Tên tham số | Kiểu tham số | Bắt buộc | Mô tả |
|---|---|---|---|
| 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. |
| productCode | String | Y | Mã sản phẩm, lấy mã sản phẩm (xem 2.7) |
| years | Int | Y | Số năm mua (hiện chỉ hỗ trợ 1, 2, 3, 4, 5), tùy theo sản phẩm cụ thể. |
| refId | String | N | Mã đơn hàng duy nhất do khách hàng cung cấp |
| verificationPic | File | N | Tài liệu xác minh dự phòng. Dùng cho xác minh tổ chức, hỗ trợ định dạng .jpg/.jpeg/.png/.gif/.bmp/.rar/.zip/.pdf, dung lượng không quá 2M. |
| domainVerificationPic | File | N | Khi phương thức xác minh tên miền là: VERIFY_DOCUMENT, mục này là Y. Dùng để xác minh quyền sở hữu tên miền (hiện chỉ hỗ trợ CFCA). |
| params | String | Y | Thông tin đặt hàng, mô tả cụ thể như sau |
| csr | String | N | Khi tham số để trống, hệ thống sẽ tạo csr cho bạn và lưu khóa riêng. |
| privateKey | String | N | Khóa riêng. |
| server | String | N | Máy chủ. Chỉ liên quan đến chứng chỉ SSL. Tham số là Y đối với chứng chỉ SSL và N đối với các loại sản phẩm khác. Nếu không cần tham số này, vui lòng đặt mặc định là “other”. |
| orgCheck | Int | N | Giá trị là 0 hoặc 1. Khi giá trị là 1, hệ thống sẽ truy xuất tất cả tổ chức trong tài khoản của bạn dựa trên thông tin tổ chức đã gửi; nếu tổ chức đã tồn tại thì sử dụng thông tin liên kết của tổ chức hiện có, nếu chưa tồn tại chúng tôi sẽ lưu thành tổ chức mới. Khi giá trị là 0, không lưu thông tin tổ chức. |
| duplicateOrgCheck | Int | N | Giá trị là 0 hoặc 1. Tham số này hiện chỉ liên quan đến chứng chỉ SSL Digicert. Dùng để xác định có tái sử dụng thông tin tổ chức và tên miền đã xác thực trước đó hay không. Khi giá trị là 1, tái sử dụng. Khi giá trị là 0, tạo mới. Mặc định là 1. |
| needFree | Int | N | Giá trị là 1 hoặc 2. Khi giá trị là 1, sẽ tặng FQDN, đồng thời www.domain cũng sẽ tặng domain. Khi giá trị là 2, không tặng. |
| uniqueValue | String | N | Chỉ liên quan đến sản phẩm Sectigo. 1-20 ký tự (a-z A-Z 0-9) dùng để nhà phân phối tự tạo giá trị xác minh. |
| dcvMethod | String | N | Thiết lập thống nhất phương thức xác minh tên miền áp dụng. Phải là một trong bốn phương thức sau: EMAIL(xác minh qua email) HTTP_CSR_HASH(xác minh qua tệp) CNAME_CSR_HASH(xác minh DNS) HTTPS_CSR_HASH(xác minh tệp https) VERIFY_DOCUMENT(chứng minh chứng chỉ tên miền, chỉ hỗ trợ CFCA) Mục này là Y đối với CFCA |
| domainInfo | String | N | Thông tin tên miền, chỉ liên quan đến chứng chỉ SSL. Tham số SSL là Y, các loại tham số khác là N. Ví dụ: [ { "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" } ] Mô tả cụ thể như sau: |
| dcvMethod | String | N | Phương thức xác thực tên miền. Phải là một trong bốn phương thức sau: EMAIL(xác thực qua email) HTTP_CSR_HASH(xác thực qua tệp) CNAME_CSR_HASH(xác thực DNS) HTTPS_CSR_HASH(xác thực tệp https) Khi dcvMethod cấp trên không tồn tại, mục này là Y. Khi dcvMethod cấp trên tồn tại và mục này cũng tồn tại, sẽ ưu tiên sử dụng dcvMethod cấp trên |
| dcvEmail | String | N | Email xác thực tên miền. Khi mục này là N, tình trạng mặc định như sau racent.com : admin@racent.com www.racent.com : admin@racent.com *.racent.com : admin@racent.com |
| domainName | String | N | Tên miền |
| organizationInfo | String | N | Thông tin công ty. Khi đặt mua sản phẩm cần xác thực doanh nghiệp, tham số này là Y. Ví dụ như sau: { "organizationCity": "上海", "organizationName": "某公司", "organizationMobile": "18111111111", "organizationAddress": "上海市路", "organizationCountry": "CN", "organizationPostCode": "401320" }" |
| organizationCity | String | N | Thành phố nơi công ty đặt trụ sở. |
| organizationName | String | N | Tên công ty. |
| organizationMobile | String | N | Số điện thoại công ty. |
| organizationAddress | String | N | Địa chỉ công ty. |
| organizationCountry | String | N | Quốc gia nơi công ty đặt trụ sở (mã hai chữ cái theo tiêu chuẩn ISO 3166-1). |
| organizationPostCode | String | N | Mã bưu chính nơi công ty đặt trụ sở. |
| organizationRegNumbe | String | N | Số chứng nhận công ty. Với CFCA mục này là Y. |
| idType | String | N | Loại chứng nhận công ty. Với CFCA mục này là Y. Giá trị như sau: TYDMZ: Mã thống nhất tín dụng xã hội OTHERS: Khác |
| Administrator | string | Y | Thông tin quản trị viên, người liên hệ. Khi đăng ký chữ ký mã, chữ ký email, chữ ký tài liệu, tham số này được dùng làm thông tin đăng ký. Ngoài ra, nếu csr là N, thông tin này được dùng làm thông tin tạo csr. { "job": "总经办", "city": "上海市", "email": "xx@yy.com", "state": "上海市", "mobile": "18111111111", "address": "上海市", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "某公司" }" |
| job | String | Y | Chức vụ của quản trị viên. |
| city | String | Y | Thành phố nơi quản trị viên cư trú. |
| String | Y | Email của quản trị viên. | |
| state | String | Y | Tỉnh hoặc bang của quản trị viên. |
| mobile | String | Y | Thông tin liên hệ của quản trị viên. |
| address | String | Y | Địa chỉ liên hệ của quản trị viên. |
| country | String | Y | Quốc gia của quản trị viên (mã hai chữ cái theo tiêu chuẩn ISO 3166-1). |
| lastName | String | Y | Họ của quản trị viên. |
| postCode | String | Y | Mã bưu chính nơi quản trị viên cư trú. |
| firstName | String | Y | Tên quản trị viên. |
| organation | String | Y | Tên công ty của quản trị viên. |
| idType | String | N | Loại giấy tờ. Đối với CFCA, mục này là Y. |
| idNumber | String | N | Số chứng minh nhân dân. Đối với CFCA, mục này là Y. |
| finance | string | Chỉ liên quan đến chứng chỉ SSL. Thông tin nhân viên tài chính. Có thể trùng với thông tin quản trị viên. Khi sản phẩm đặt mua không thuộc loại dv, tham số này là Y. { "job": "Phòng Tài chính", "city": "Thượng Hải", "email": "xx@yy.com", "state": "Thượng Hải", "mobile": "18111111111", "address": "Thượng Hải", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "Công ty XYZ" }" | |
| job | String | N | Chức vụ của nhân viên tài chính. |
| city | String | N | Thành phố nơi nhân viên tài chính cư trú. |
| String | N | Email của nhân viên tài chính. | |
| state | String | N | Tỉnh hoặc bang nơi nhân viên tài chính cư trú. |
| mobile | String | N | Thông tin liên hệ của nhân viên tài chính. |
| address | String | N | Địa chỉ liên hệ của nhân viên tài chính. |
| country | String | N | Quốc gia của nhân viên tài chính (mã hai chữ cái theo tiêu chuẩn ISO 3166-1). |
| lastName | String | N | Họ của nhân viên tài chính. |
| postCode | String | N | Mã bưu chính nơi nhân viên tài chính cư trú. |
| firstName | String | N | Tên của nhân viên tài chính. |
| organation | String | N | Công ty của nhân viên tài chính. |
| idType | String | N | Loại giấy tờ tùy thân. Đối với CFCA, mục này là Y. Giá trị như sau: SFZ: Chứng minh nhân dân HZ: Hộ chiếu |
| idNumber | String | N | Số giấy tờ tùy thân. Đối với CFCA, mục này là Y. |
| tech | string | N | Chỉ liên quan đến chứng chỉ SSL. Thông tin kỹ thuật viên. Khi sản phẩm đặt mua không thuộc loại dv, tham số này là Y. { "job": "Phòng kỹ thuật","city": "Thượng Hải", "email": "xx@yy.com", "state": "Thượng Hải", "mobile": "18111111111", "address": "Thượng Hải", "country": "CN", "lastName": "zhang", "postCode": "401320", "firstName": "nick", "organation": "Công ty XYZ" }" |
| job | String | N | Chức vụ của kỹ thuật viên. |
| city | String | N | Thành phố nơi kỹ thuật viên làm việc. |
| String | N | Email của kỹ thuật viên. | |
| state | String | N | Tỉnh hoặc bang nơi kỹ thuật viên cư trú. |
| mobile | String | N | Thông tin liên hệ của kỹ thuật viên. |
| address | String | N | Địa chỉ liên hệ của kỹ thuật viên. |
| country | String | N | Quốc gia của kỹ thuật viên (mã hai chữ cái theo tiêu chuẩn ISO 3166-1). |
| lastName | String | N | Họ của kỹ thuật viên. |
| postCode | String | N | Mã bưu chính nơi kỹ thuật viên cư trú. |
| firstName | String | N | Tên kỹ thuật viên. |
| organation | String | N | Công ty nơi kỹ thuật viên làm việc. |
| 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. |
Hàm trả về
| Tên tham số | Kiểu tham số | Bắt buộc | Mô tả |
|---|---|---|---|
| code | Int | Y | Trạng thái trả về, chi tiết xem Phụ lục 3.1 |
| errors | Object hoặc String | N | Khi trạng thái trả về là lỗi, thông tin lỗi cụ thể. |
| data | Object | N | Khi trạng thái trả về là thành công, tham số này là Y. Mô tả cụ thể như sau: |
| certId | String | N | ID chứng chỉ racent. Vui lòng lưu giữ cẩn thận, đây là mã xác thực duy nhất của phiên bản racent. |
| failReason | Object | N | Khi Racent yêu cầu chứng chỉ từ CA thất bại và có thể xác định rõ nguyên nhân thất bại, mục này sẽ được trả về. |
| 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 |
| vendorId | String | N | Số đơn hàng CA。 |
| vendorCertId | String | N | Số chứng chỉ CA。 |
| DCVfileName | String | N | Tên tệp xác thực tệp |
| DCVfileContent | String | N | Nội dung tệp xác thực tệp |
| DCVdnsHost | String | N | Giá trị máy chủ xác thực DNS |
| DCVdnsValue | String | N | Giá trị bản ghi xác thực DNS |
| DCVdnsType | String | N | Loại bản ghi xác thực DNS |
| DCVfilePath | String | N | Đường dẫn tệp xác thực tệp |
| dcvInfo | Object | N | Khi giá trị xác thực của từng tên miền trong chứng chỉ được yêu cầu khác nhau, mục này là Y Mỗi mục có kiểu Object, tên đối tượng của mỗi mục là tên miền được yêu cầu, ví dụ: racent.com。Chi tiết từng mục như sau： |
| DCVfileName | String | N | Nội dung tệp xác thực tệp |
| DCVfileContent | String | N | Nội dung tệp xác thực tệp |
| DCVdnsHost | String | N | Giá trị host xác thực DNS |
| DCVdnsValue | String | N | Giá trị bản ghi xác thực DNS |
| DCVdnsType | String | N | Loại bản ghi xác thực DNS |
| DCVfilePath | String | N | Đường dẫn tệp xác thực tệp |