API này được sử dụng để cung cấp mã phiếu thưởng Slevomat.cz sau khi khách hàng thanh toán cho đơn đặt hàng của họ. Thông thường Slevomat.cz tạo mã phiếu thưởng của riêng mình, nhưng API này có thể được sử dụng để thông báo về đơn đặt hàng của đối tác kinh doanh của chúng tôi, người này có thể tạo mã phiếu thưởng của riêng mình cho khách hàng.
Tất cả các yêu cầu được thực hiện thông qua giao thức HTTPS (yêu cầu máy chủ của đối tác thương mại hỗ trợ giao thức này và có chứng chỉ hợp lệ). Tất cả dữ liệu phải ở định dạng JSON .
Danh sách các thay đổi
01/03/2017 – thêm phần xử lý các yêu cầu không hợp lệ
02/10/2017 – phiên bản gốc
Chạy API
Tất cả các yêu cầu được thực hiện bởi ứng dụng Slevomat.cz bằng cách gửi yêu cầu đến máy chủ của đối tác. Yêu cầu sẽ chứa tiêu đề HTTPX-RequestToken với một chuỗi bí mật. Chuỗi này phải được kiểm tra bởi máy chủ của đối tác để đảm bảo tính bảo mật. Chỉ Slevomat.cz và đối tác biết chuỗi bí mật này.
Để kích hoạt API, đối tác phải yêu cầu Slevomat.cz và cung cấp địa chỉ URL mà API sẽ truy cập, ví dụ:
https://example.com/slevomat-external-voucher-code/generate
Ngay sau khi Slevomat.cz kích hoạt API cho đối tác và chuyển giá trị cho anh taX-RequestToken , ban đầu API chỉ được thiết lập ở chế độ thử nghiệm. Điều này có nghĩa là không có đơn đặt hàng thực tế nào yêu cầu lấy mã phiếu thưởng của riêng mình. Tuy nhiên, nó cho phép đối tác phát triển và thử nghiệm API trên máy chủ của họ.
Sau khi thử nghiệm API trên máy chủ của đối tác Slevomat.cz, nó sẽ chuyển sang chế độ sắc nét. Các đơn đặt hàng bắt đầu bán sau khi chuyển đổi giờ đây sẽ yêu cầu API của đối tác cung cấp mã phiếu thưởng của riêng họ.
Tạo mã chứng từ
Sau khi thanh toán đơn hàng cho cửa hàng, Slevomat.cz gửi yêu cầu POST đến máy chủ của đối tác để tạo mã phiếu thưởng và cung cấp cho đối tác một số thông tin về đơn hàng. Yêu cầu này sẽ được gửi riêng cho từng mặt hàng đã 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 bằng mã trạng thái HTTP 200 và nội dung phản hồi với mã chứng từ được tạo sẽ 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ã chứng từ được tạo phải bắt đầu bằng tiền tố đã cho 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ý do trong trườngrepeatReason , cho đến khi 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 | Lần thử đầ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ể cho biết chứng chỉ HTTPS không hợp lệ hoặc có thể đã xảy ra sự cố mất mạ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ột mã khác với 200 HTTP. |
| 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 mã phiếu thưởng. |
| 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ệ. Các ký tự hợp lệ là:[a-zA-Z0-9-]+ .
|
| số 8 | Mã chứng từ được tạo không phải là duy nhất. |
Nội dung yêu cầu sẽ luôn chứa cùng một mã định danhuuid như một yêu cầu trước đó để tạo mã phiếu thưởng 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ệ
Nếu một yêu cầu xảy ra 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ã Bị cấm HTTP 403.
thử nghiệm API
Đăng ký làm đối tác của chúng tôi. Trong giao diện, sau đó bạn có thể tìm hiểu trạng thái API của mình và có thể thử nghiệm cũng như thiết lập nó.