CitrusAd hoạt động như thế nào?
API CitrusAd được tổ chức xung quanh REST. API có các URL hướng tài nguyên, có thể dự đoán và sử dụng mã phản hồi HTTP để chỉ ra lỗi API. API sử dụng các tính năng HTTP tích hợp bao gồm xác thực HTTP và các HTTP verb, được hiểu bởi các ứng dụng khách HTTP không tùy biến.
Quá trình xác thực API CitrusAd được quản lý bằng các mã khóa API. Mã khóa API được dùng trong quá trình giao tiếp giữa backend của bạn và API CitrusAd.
API CitrusAd hỗ trợ tải lên sản phẩm, danh mục, khách hàng và dữ liệu đơn hàng dùng để tạo quảng cáo. Bạn có thể dùng API CitrusAd để yêu cầu quảng cáo và báo cáo về các tương tác với những quảng cáo đó.
Điểm cuối CitrusAd
CitrusAd sử dụng các điểm cuối khác nhau để đồng bộ hóa dữ liệu và tạo quảng cáo. Dưới đây là phần tóm tắt ngắn gọn:
| Điểm cuối | Sử dụng | Mô tả |
|---|---|---|
catalogs | Đồng bộ hóa danh mục qua API | Được sử dụng để tạo danh mục thông qua API. Đối với không gian tên danh mục đơn lẻ, đây là điều mà người quản lý tài khoản kỹ thuật có thể sắp xếp cho bạn. |
catalog-products | Đồng bộ hóa sản phẩm thông qua API | Dùng để tạo và cập nhật dữ liệu sản phẩm trong danh mục. |
customers | Đồng bộ hóa dữ liệu khách hàng thông qua API | Dùng để tạo và cập nhật dữ liệu khách hàng trong danh mục. |
orders | Đồng bộ hóa dữ liệu đơn hàng thông qua API | Dùng để gửi dữ liệu đơn hàng đến CitrusAd. |
/resource/ | Báo cáo số lần nhấp chuột và số lần hiển thị , Đồng bộ hóa dữ liệu đơn hàng qua API | Dùng để báo cáo số lần nhấp, số lần hiển thị và đơn hàng nếu báo cáo qua giao diện người dùng. |
/ads/generate | Tạo quảng cáo | Dùng để tạo quảng cáo sản phẩm và quảng cáo biểu ngữ. |
/ads/bannerx | Tạo quảng cáo | Được sử dụng để tạo quảng cáo biểu ngữ x. |
Bạn không cần sử dụng điểm cuối để đồng bộ hóa danh mục, sản phẩm, khách hàng và đơn hàng. CitrusAd hỗ trợ đồng bộ hóa dữ liệu bằng tệp. Tính năng này có thể phù hợp với yêu cầu của bạn.
Loại nội dung và tải trọng dữ liệu
Tải trọng dữ liệu có định dạng JSON. Mã Content-Type đối với các điểm cuối này là application/json, sẽ được chuyển dưới dạng tiêu đề trong các yêu cầu của bạn như sau:
-H "Content-Type: application/json" \
Xác thực các yêu cầu
Xác thực cơ bản
Tất cả các tài nguyên tích hợp sử dụng phương thức xác thực cơ bản cần được thông qua dưới dạng tiêu đề bằng mã khóa API của bạn như sau:
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
Bạn có thể truy cập Mã khóa API của mình trong mục Cài đặt tích hợp của nhóm nhà bán lẻ. Bạn sẽ chỉ cần mã khóa API bí mật đó.
Xác thực OAuth2.0
Điểm cuối tạo quảng cáo của CitrusAd tương thích với cả OAuth2.0. Xem mục Xác thực OAuth 2.0 để biết thêm thông tin.
Các URL cơ sở
CitrusAd sử dụng nhiều URL cơ sở khác nhau cho môi trường dàn dựng và sản xuất.
Để nhận URL cơ sở phân đoạn của bạn, vui lòng liên hệ với CitrusAd. Khi đang tích hợp, chúng tôi sẽ cung cấp cho bạn các URL cơ bản sản xuất.