API này dùng để cung cấp cho Slevomat.cz mã phiếu thưởng sau khi khách hàng thanh toán đơn đặt hàng cho một giao dịch. Thông thường, Slevomat.cz tạo mã phiếu thưởng của riêng mình, nhưng bằng cách sử dụng API này, đối tác kinh doanh của chúng tôi có thể được thông báo về đơn đặt hàng và tạo mã phiếu thưởng tùy chỉnh của riêng họ cho khách hàng.
Tất cả các yêu cầu được thực hiện qua giao thức HTTPS (yêu cầu máy chủ của đối tác kinh doanh hỗ trợ HTTPS và có chứng chỉ hợp lệ) và tất cả dữ liệu phải được định dạng là JSON .
Nhật ký thay đổi
01/03/2017 – thêm phần xử lý yêu cầu không hợp lệ
Ngày 10 tháng 2 năm 2017 – phiên bản ban đầu
Kích hoạt API
Tất cả các yêu cầu được thực hiện bởi ứng dụng Slevomat.cz gửi yêu cầu đến máy chủ của đối tác. Yêu cầu sẽ chứaX-RequestToken Tiêu đề HTTP với một chuỗi bí mật. Chuỗi này phải được máy chủ của đối tác kiểm tra để đảm bảo tính bảo mật. Chuỗi bí mật này chỉ được biết bởi Slevomat.cz và đối tác.
Để bật API, đối tác phải yêu cầu Slevomat.cz và cung cấp URL chứa API, ví dụ:
https://example.com/slevomat-external-voucher-code/generate
Sau khi Slevomat.cz kích hoạt API cho đối tác và cung cấp cho đối tácX-RequestToken giá trị, nó chỉ ở chế độ thử nghiệm, nghĩa là không có đơn đặt hàng thực nào sẽ thực hiện yêu cầu lấy mã phiếu thưởng tùy chỉnh. Nhưng nó cho phép đối tác phát triển và thử nghiệm API trên máy chủ của mình vớiX-RequestToken giá trị.
Sau khi API trên máy chủ của đối tác được phát triển và thử nghiệm, Slevomat.cz sẽ chuyển chế độ sang đơn đặt hàng thực. Đơn đặt hàng cho giao dịch bắt đầu bán sau khi chuyển đổi sẽ yêu cầu API của đối tác cho mã chứng từ tùy chỉnh.
Tạo mã chứng từ
Khi một đơn đặt hàng cho một giao dịch được thanh toán, Slevomat.cz sẽ gửi yêu cầu POST đến máy chủ của đối tác để tạo mã phiếu thưởng và sẽ cung cấp cho đối tác một số thông tin về đơn đặt hàng. Yêu cầu này sẽ được gửi riêng cho từng đơn vị được bán.
Yêu cầu chứa tiền tố mã chứng từ được yêu cầu. Mã chứng từ được tạo phải bắt đầu bằng tiền tố này .
Nội dung yêu cầu sẽ trông như thế này:
{ "uuid": "91987a73-095c-4b94-bd38-f6ffd4ab86a7", "deal": { "product_id": 123, "product_name": "Aktivní dovolená: 4 až 6 dní s all inclusive v Rakousku. 2 děti do 8,9 let zdarma!", "variant_id": 456, "variant_name": "1 osoba | 4 dny (3 noci) | Období So 13. 5. – So 24. 6. 2017, Ne 27. 8. – Ne 5. 11. 2017" }, "customer": { "email": "cu******@ex*****.com" }, "voucherCodePrefix": "LIN", "repeatReason": 1 }Máy chủ sẽ phản hồi với mã trạng thái HTTP 200 và nội dung phản hồi với mã phiếu thưởng được tạo phải giống như sau:
{ "voucherCode": "LIN1234567890" }Máy chủ phải trả lời trong vòng 10 giây , nếu không, yêu cầu được đánh dấu là không thành công. Mã phiếu thưởng được tạo phải bắt đầu bằng một tiền tố nhất định và phải là duy nhất. Có những lý do khác khiến chúng tôi không thể chấp nhận mã phiếu thưởng đã tạo.
Khi yêu cầu không thành công, nó được lặp lại với lý dorepeatReason trường cho đến khi nó thành công. Trường này sẽ chứa một trong các giá trị sau:
| lặp lại lý do | Sự miêu tả |
|---|---|
| 1 | Nỗ lực đầu tiên. |
| 2 | Kết nối với máy chủ không thành công. Điều này có thể có nghĩa là chứng chỉ HTTPS không hợp lệ hoặc mạng đã ngừng hoạt động. |
| 3 | Máy chủ không phản hồi kịp thời. |
| 4 | Máy chủ đã phản hồi bằng mã trạng thái HTTP không phải 200. |
| 5 | Máy chủ đã phản hồi bằng HTTP 200 nhưng nội dung phản hồi không chứa JSON hoặc JSON không chứa khóa voucherCode. |
| 6 | Mã chứng từ đã tạo không chứa tiền tố bắt buộc. |
| 7 | Mã chứng từ đã tạo chứa các ký tự không hợp lệ. Chỉ các ký tự hợp lệ là:[a-zA-Z0-9-]+ . |
| số 8 | Mã chứng từ đã tạo không phải là duy nhất. |
Nội dung yêu cầu sẽ luôn chứa cùnguuid định danh làprevious yêu cầu tạo mã chứng từ cho cùng một đơn đặt hàng của khách hàng.
Xử lý yêu cầu không hợp lệ
Khi sẽ xảy ra một yêu cầu không đáp ứng các yêu cầu bảo mật, tức là chứa một yêu cầu không hợp lệX-RequestToken , máy chủ phải phản hồi bằng mã HTTP 403 Bị cấm.
Kiểm tra triển khai API
Đăng nhập với tư cách là đối tác của chúng tôi để xem trạng thái API của bạn, đồng thời kiểm tra và xác minh việc triển khai API của bạn.