NAV Navbar
Logo

Base Endpoint

https://api.accesstrade.vn

Authentication

Authentication:

Authorization: Token <access_key>
Content-Type: application/json

Tất cả các request đến API đều yêu cầu token trong header (bao gồm tất cả các methods: GET, POST, PUT...)

Authorization: Token <access_key>

Content-Type: application/json

Lấy danh sách giao dịch

API response trả về:

{
  "total": 1,
  "data": [
    {
      "id": "759720136818247525cdca9532a5d82a",
      "status": 0,
      "merchant": "tikivn",
      "utm_term": "",
      "utm_content": "",
      "utm_source": "",
      "utm_campaign": "",
      "utm_medium": "",
      "click_time": "2016-08-01T16:53:30",
      "transaction_id": "32964233",
      "transaction_value": 586364,
      "transaction_time": "2016-08-01T16:57:50",
      "update_time": "2016-08-03T14:37:20",
      "confirmed_time": "2016-08-01T16:57:50",
      "is_confirmed": 0,
      "commission": 23454,
      "product_id": "1975",
      "product_price": 586364,
      "product_quantity": 1,
      "_extra": {
        "device_model": null,
        "device_family": "Other",
        "device_brand": null,
        "device_type": "pc",
        "device": "None Other",
        "os": "Windows 7",
        "browser": "Chrome"
      }
    }
  ]
}

HTTP Request

GET https://api.accesstrade.vn/v1/transactions

Query Parameters

Các biến params được truyền vào HTTP Request theo các cặp Key-Value, mở đầu chuỗi params bằng dấu “?” và giữa các biến phân tách nhau bằng dấu “&”. Vd: https://api.accesstrade.vn/v1/transactions?since=2016-08-01T00:00:00Z&until=2016-08-02T00:00:00Z

Biến params Required Mô tả
since Bắt buộc Thời gian bắt đầu report theo sale time (ISO format), ví dụ “2016-08-01T00:00:00Z”.
until Bắt buộc Thời gian kết thúc report theo sale time (ISO format), ví dụ “2016-08-02T00:00:00Z”.
offset Tùy chọn Offset value, default 0.
limit Tùy chọn Số kết quả trả về mỗi lần, default 100.
merchant Tùy chọn Tên merchant. ex: tikivn.
utm_source Tùy chọn Ex: facebook
utm_campaign Tùy chọn
utm_medium Tùy chọn Ex: email
utm_content Tùy chọn
status Tùy chọn Trạng thái giao dịch: 0 - hold, 1 - approved, 2 - rejected
is_confirmed Tùy chọn Trạng thái giao dịch: 0 - chưa duyệt, 1 - đã duyệt (Nếu có tham số is_confirmed mà không có status thì mặc định trường status=1)
transaction_id Tùy chọn Mã giao dịch, có thể filter 1 (transaction_id=1234567) hoặc nhiều (transaction_id=1234567,7654321) bằng cách dùng dấu phẩy “,” để ngăn cách các mã.
update_time_start Tùy chọn Thời gian bắt đầu report theo thời gian update transaction (ISO forrmat), ví dụ “2016-08-01T00:00:00Z”.
update_time_end Tùy chọn Thời gian kết thúc report theo thời gian update transaction (ISO forrmat), ví dụ “2016-08-05T00:00:00Z”.

Mô tả kết quả

Tham số Mô tả
total Số lượng conversion, tính theo từng sản phẩm.
data.id Conversion id.
data.status Trạng thái của conversion, 0: Pending or hold, 1: Approved, 2:Rejected.
data.merchant Tên merchant.
data.click_time Thời gian phát sinh click, theo ISODate.
data.transaction_id ID của giao dịch (Đơn hàng).
data.transaction_time Thời gian phát sinh giao dịch, theo ISODate.
data.update_time Thời gian update thông tin giao dịch, theo ISODate.
data.confirmed_time Thời gian duyệt giao dịch, theo ISODate.
data.is_confirmed Trạng thái giao dịch: 0 - chưa duyệt, 1 - đã duyệt
data.transaction_value Giá trị giao dịch.
data.commission Hoa hồng cho publisher.
data.product_id ID của sản phẩm.
data.product_price Giá của sản phẩm.
data.product_quantity Số lượng sản phẩm.
data._extra Các thông tin liên quan đến hệ điều hành và trình duyệt.
data._utm* Giá trị các tham số utm.

Ví dụ minh họa (Dùng tool Postman để call API)

transactions.png

Lấy danh sách campaigns

API response trả về


{
  "total":10
  "data": [
    {
      "approval": "unregistered",
      "category": "ONLINE SERVICES",
      "conversion_policy": "",
      "cookie_duration": 86400,
      "cookie_policy": "",
      "description": "Đã đến lúc kết thúc kỷ nguyên của E-mail và Skype!",
      "end_time": null,
      "id": "4448826536895067593",
      "merchant": "chatwork",
      "name": "Chatwork Chat nhóm xuyên quốc gia",
      "scope": "public",
      "start_time": "2017-02-17T00:00:00",
      "status": 1,
      "sub_category": "",
      "type": 0,
      "url": "http://www.chatwork.com/vi/"
    }
  ]
}

HTTP Request

GET https://api.accesstrade.vn/v1/campaigns

Mô tả kết quả

Tham số Mô tả
total Số lượng chiến dịch (campaigns).
data.id Id của campaign.
data.name Tên chiến dịch.
data.approval unregistered: User chưa đăng kí chiến dịch. pending: Chiến dịch đang chờ duyệt cho user. successful: User được chấp thuận chạy chiến dịch.
data.status Trạng thái của campaign, 1: Running.
data.merchant Tên merchant.
data.conversion_policy
data.cookie_duration Thời gian hiệu lực của cookie (second).
data.cookie_policy
data.description Mô tả campaign.
data.start_time Ngày băt đầu campaign.
data.end_time Ngày kết thúc campaign.
data.category
data.sub_category
data.type
data.url Url campaign.

Ví dụ minh họa (Dùng tool Postman để call API)

campaigns.png

Lấy danh sách tỷ lệ chia sẻ hoa hồng của campaign

API response trả về


{
  "category": [
    {
      "category_id": "683", 
      "sales_price": 0.0, 
      "sales_ratio": 0.03, 
      "taget_month": "02/2017"
    }
  ], 
  "default": [
    {
      "result_id": 3, 
      "reward_type": 2, 
      "sales_price": 0.0, 
      "sales_ratio": 0.03, 
      "taget_month": "02/2017"
    }
  ], 
  "product": [
    {
      "product_id": "2", 
      "sales_price": 0.0, 
      "sales_ratio": 0.02, 
      "taget_month": "02/2017"
    }]
}

HTTP Request

GET https://api.accesstrade.vn/v1/commission_policies

Query Parameters

Các biến params được truyền vào HTTP Request theo các cặp Key-Value, mở đầu chuỗi params bằng dấu “?” và giữa các biến phân tách nhau bằng dấu “&”. Vd: https://api.accesstrade.vn/v1/commission_policies?camp_id=147&month=08-2016

Biến params Required Mô tả
camp_id bắt buộc Id của campaign.
month tùy chọn Tháng áp dụng chính sách.

Mô tả kết quả

Tham số Mô tả
category.category_id Id của category.
category.sales_price Số tiền chia sẻ (fixed) cho từng conversion thành công.
category.sales_ratio Tỷ lệ chi sẻ theo giá trị đơn hàng cho từng conversion thành công.
category.taget_month Tháng có hiệu lực.
product.category_id Id của Product.
product.sales_price Số tiền chia sẻ (fixed) cho từng conversion thành công.
product.sales_ratio Tỷ lệ chi sẻ theo giá trị đơn hàng cho từng conversion thành công.
product.taget_month Tháng có hiệu lực.
default.result_id Loại commission mặc định: 1 - Fixed giá tiền. 3 - Chia sẻ theo từng sản phẩm (product). 30 - Chia sẻ theo từng danh mục (category)
default.reward_type Cách tính commmission: 1 - Tính giá cố định. 2 - Tính tỉ lệ theo giá trị đơn hàng
default.sales_price Số tiền chia sẻ (fixed) cho từng conversion thành công.
default.sales_ratio Tỷ lệ chi sẻ theo giá trị đơn hàng cho từng conversion thành công.
default.taget_month Tháng có hiệu lực.
category.category_id Id của category.
category.sales_price Số tiền chia sẻ (fixed) cho từng conversion thành công.
category.sales_ratio Tỷ lệ chi sẻ theo giá trị đơn hàng cho từng conversion thành công.

Ví dụ minh họa (Dùng tool Postman để call API)

commission_policies.png

Lấy danh sách đơn hàng

API response trả về


{
  "data": [
    {
      "at_product_link": "http://tiki.vn/thoi-trang?utm_campaign=1&utm_medium=affiliate&utm_source=accesstrade",
      "billing": 126364,
      "browser": "Chrome",
      "click_time": "2017-01-23T09:58:20",
      "client_platform": "pc",
      "confirmed_time": "2017-01-31T00:00:00",
      "is_confirmed": 0,
      "landing_page": "http://accesstrade.vn/",
      "merchant": "tikivn",
      "order_id": "82433994",
      "order_pending": 0,
      "order_reject": 1,
      "order_success": 0,
      "order_uid": "",
      "product_category": "914",
      "products": [
        {
          "_at": {
            "banner_id": 860,
            "commission_type": 2,
            "goods_id": "289907",
            "result_id": 30,
            "reward_type": 2,
            "seq_no": 911090
          },
          "_extra": {
            "browser": "Chrome",
            "device": "None Other",
            "device_brand": null,
            "device_family": "Other",
            "device_model": null,
            "device_type": "pc",
            "os": "Windows 7"
          },
          "amount": 126364,
          "campaign_id": "62",
          "click_time": "2017-01-23T09:58:20",
          "confirmed_time": "2017-01-31T00:00:00",
          "merchant": "tikivn",
          "product_id": "289907",
          "product_price": 126364,
          "product_quantity": 1,
          "pub_commission": 5054,
          "sales_time": "2017-01-23T09:59:03",
          "status": 2
        }
      ],
      "products_count": 1,
      "pub_commission": 5054,
      "publisher": "tester",
      "sales_time": "2017-01-23T09:59:03",
      "total_commission": 0,
      "utm_campaign": "",
      "utm_medium": "",
      "utm_source": "",
      "website": "accesstrade.vn",
      "website_url": "http://accesstrade.vn/"
    }
  ],
  "total": 123,
  "total_page": 4
}

HTTP Request

GET https://api.accesstrade.vn/v1/orders

Query Parameters

Các biến params được truyền vào HTTP Request theo các cặp Key-Value, mở đầu chuỗi params bằng dấu “?” và giữa các biến phân tách nhau bằng dấu “&”. Vd: https://api.accesstrade.vn/v1/orders?since=2016-08-01T00:00:00Z&until=2016-08-02T00:00:00Z

Biến params Required Mô tả
since bắt buộc Thời gian bắt đầu report, theo ISO format, ví dụ “2016-08-01T00:00:00Z”.
until bắt buộc Thời gian kết thúc report, theo ISO format, ví dụ “2016-08-02T00:00:00Z”.
page tùy chọn Thứ tự page .
limit tùy chọn Giới hạn đơn hàng trả về.
status tùy chọn Trạng thái của conversion, 0: Pending or hold, 1: Approved, 2:Rejected.
is_confirmed tùy chọn Trạng thái giao dịch: 0 - chưa duyệt, 1 - đã duyệt (Nếu có tham số is_confirmed mà không có status thì mặc định trường status=1)
merchant tùy chọn Vi dụ: adayroi, lazada.

Ví dụ minh họa (Dùng tool Postman để call API)

orders.png

Lấy thông tin chi tiết sản phẩm

API response trả về


{
  "brand": "",
  "category_id": "",
  "category_name": "ĐIỆN MÁY & CÔNG NGHỆ > Thiết bị nhà bếp > Máy xay máy ép trái cây > Máy ép trái cây",
  "desc": "<p>- Chất liệu thân máy bằng nhựa cao cấp</p><br/><p>- Máy có công suất 500 W</p><br/><p>- Ly đựng nước ép có dung tích lớn</p><br/><p>- Máy được trang bị lưới lọc làm bằng thép không gỉ</p><br/><p>- Ép trái cây với tốc độ cao</p><br/><p>- Bảo hành 12 tháng theo phiếu bảo hành</p>",
  "image": "https://cdn02.static-adayroi.com/0/2016/05/23/1463982160655_6703084.jpg",
  "link": "https://www.adayroi.com/may-ep-trai-cay-toc-do-cao-lock-lock-elje-100-den-p-550Wm-f1-2?pi=My3Rz&w=p0l9",
  "name": "Máy ép trái cây tốc độ cao Lock&amp;Lock ELJE-100 (Đen)",
  "short_desc": "<p>- Chất liệu thân máy bằng nhựa cao cấp</p><br/><p>- Máy có công suất 500 W</p><br/><p>- Ly đựng nước ép có dung tích lớn</p><br/><p>- Máy được trang bị lưới lọc làm bằng thép không gỉ</p><br/><p>- Ép trái cây với tốc độ cao</p><br/><p>- Bảo hành 12 tháng theo phiếu bảo hành</p>"
}

HTTP Request

GET https://api.accesstrade.vn/v1/product_detail

Các biến params được truyền vào HTTP Request theo các cặp Key-Value, mở đầu chuỗi params bằng dấu “?” và giữa các biến phân tách nhau bằng dấu “&”. Vd: https://api.accesstrade.vn/v1/product_detail?merchant=lazada&product_id=12345678

Query parameters

Biến params Required Mô tả
merchant bắt buộc Vi dụ: adayroi, lazada.
product_id bắt buộc Id sản phẩm.

Ví dụ minh họa (Dùng tool Postman để call API)

product_detail.png

Lấy thông tin datafeeds

API response trả về


{
  "data": [
    {
      "aff_link": "https://fast.accesstrade.com.vn/deep_link/4348611826491973833?url=http%3A%2F%2Fwww.lazada.vn%2Fao-thun-cao-cap-hinh-star-wars-coffee-mitadi-aste072-2423013.html",
      "cate": "thoi-trang-my-pham",
      "category_commission": {
        "partner_reward": "8.00%",
        "reward_type": "Amount sold"
      },
      "desc": null,
      "discount": 149000,
      "campaign": "lazada",
      "domain": "lazada.vn",
      "image": "http://vn-live-01.slatic.net/p/7/image-3103242-3b4b9c7018198c05f648390fb741036c-product.jpg",
      "name": "Áo Thun Cao Cấp Hình Star Wars Coffee - MITADI – ASTE072",
      "price": 175000,
      "product_id": "142_AN273FAAA1FXLXVNAMZ-2293380",
      "sku": "AN273FAAA1FXLXVNAMZ-2293380",
      "status_discount": 1,
      "discount_amount": 26000,
      "discount_rate": 14.86,
      "update_time": "14-09-2017T13:22:34",
      "url": "http://www.lazada.vn/ao-thun-cao-cap-hinh-star-wars-coffee-mitadi-aste072-2423013.html"
    },
}

HTTP Request

GET https://api.accesstrade.vn/v1/datafeeds

Các biến params được truyền vào HTTP Request theo các cặp Key-Value, mở đầu chuỗi params bằng dấu “?” và giữa các biến phân tách nhau bằng dấu “&”. Vd: https://api.accesstrade.vn/v1/datafeeds?domain=lazada.vn&sku=hehihoha1234

Query parameters

Biến params Required Mô tả
campaign tùy chọn Merchant của owner sản phẩm. vd: lazada
domain tùy chọn Domain của owner sản phẩm. vd: lazada.vn
discount_amount_from tùy chọn lọc giá được giảm (chiết khấu) từ
discount_amount_to tùy chọn lọc giá được giảm (chiết khấu) đến
discount_rate_from tùy chọn lọc tỷ lệ giá được giảm từ
discount_rate_to tùy chọn lọc tỷ lệ giá được giảm đến
page tùy chọn Nhập số thứ tự page lấy ra, max = total/limit. Mặc định = 1
limit tùy chọn Số lượng sản phẩm cần lấy, mặc định là 50, max = 200
price_from tùy chọn lọc giá ban đầu từ
price_to tùy chọn lọc giá ban đầu đến
discount_from tùy chọn lọc giá khuyến mại từ
discount_to tùy chọn lọc giá khuyến mại đến
status_discount tùy chọn lọc theo trạng thái khuyến mại. 0 - không được khuyến mại, 1 - có khuyến mại
update_from tùy chọn lọc theo thời gian update datafeed từ. vd: 08-09-2017
update_to tùy chọn lọc theo thời gian update datafeed đến. vd: 10-09-2017

Mô tả kết quả

Key Mô tả
cate Danh mục sản phẩm
desc Mô tả chi tiết sản phẩm
discount giá sau khuyến mại
campaign chiến dịch
domain domain của owner sản phẩm
image url ảnh sản phẩm
name tên sản phẩm
price giá sản phẩm trước khuyến mại
product_id id của sản phẩm
sku mã sản phẩm
url link sản phẩm
aff_link Deep link
status_discount trạng thái khuyến mại. 0 - ko khuyến mại, 1 - có khuyến mại
discount_amount giá được giảm
discount_rate phần trăm được giảm
update_time thời gian update

Ví dụ minh họa (Dùng tool Postman để call API)

datafeeds.png

Lấy thông tin các khuyến mại đang hoạt động

API response trả về


{
      "categories": [
        {
          "category_name": "voucher-dich-vu",
          "category_name_show": "Voucher & Dịch vụ",
          "category_no": 118
        },
      ],
      "banners": [
        {
          "height": 600,
          "link": "http://static.accesstrade.vn/publisher/www/files/img_promo/offer/banner/bookin/160x600/320x100.png",
          "width": 160
        },
        {
          "height": 600,
          "link": "http://static.accesstrade.vn/publisher/www/files/img_promo/offer/banner/bookin/600x600/320x100.png",
          "width": 600
        },
      ],
      "content": "\"1/ TRỪ ngay đến 100k cho 07 đơn hàng đầu đặt vé trong thứ 7 hàng tuần \r\n2/ GIẢM 10%: VC giảm đến 10% giá trị và GIẢM 10% Combo vé + KS cho khách đặt vé\r\n3/ TẶNG Taxi 1 chiều và khứ hồi cho khách đặt vé.\r\n*Lưu ý:\r\n- Với 07 đơn hàng đầu tiên đặt vé của thứ 7 hàng tuần: Giảm ngay 50k cho đơn hàng dưới 3 triệu, 100k cho đơn hàng trên 3 triệu.\r\n- Tặng VOUCHER giảm giá đến 10% GIÁ TRỊ:  Đơn hàng đến 3 triệu tặng voucher 200k, trên 3tr tặng voucher 300k; mỗi lần sử dụng được trừ 100k; thời gian sử dụng cách thời điểm nhận 07 ngày.\r\n- GIẢM 10% Combo vé + KS: đến 10% giá phòng khách sạn với khách đã đặt vé.\r\n- Free Taxi một chiều/ khứ hồi: theo từng trường hợp.",
      "id": "4543700225480618112",
      "image": "http://static.accesstrade.vn/publisher/www/files/img_promo/offer/img/bookin/600x600.png",
      "link": "http://www.topmot.vn/",
      "merchant": "topmot",
      "start_time": "2017-02-18T00:00:00",
      "end_time": "2017-02-23T00:00:00",
      "domain": "topmot.vn",
      "aff_link": "https://fast.accesstrade.com.vn/deep_link/4496607189591958814?url=https%3A%2F%2Fwww.topmot.vn%2Fcampaigns%2Farte-balo-sac-mau-ca-tinh%3Futm_source%3DAffiliate%26utm_medium%3DAccesstrade%26utm_campaign%3DArte%26utm_content%3DArte",
      "name": "Hè sang, du lịch rộn ràng, ngập tràn ưu đãi"
}

HTTP Request

GET https://api.accesstrade.vn/v1/offers_informations

Query parameters

Các biến params được truyền vào HTTP Request theo các cặp Key-Value, mở đầu chuỗi params bằng dấu “?” và giữa các biến phân tách nhau bằng dấu “&”. Vd: https://api.accesstrade.vn/v1/offers_informations?scope=expiring&merchant=lazada

Biến params Required Mô tả
scope tùy chọn Truyền value cho tham số này là “expiring” để get các khuyến mại sắp hết hạn. Lấy tất cả nếu không truyền hoặc truyền sai value.
merchant tùy chọn Tên owner của khuyến mại. vd: lazada
categories tùy chọn category_name của khuyến mại. Ex: voucher-dich-vu. Có thể truyền nhiều category, phân cách nhau bằng dấu phẩy ","
domain tùy chọn Domain của khuyến mại. vd: lazada.vn
coupon tùy chọn Truyền value là 1 để get khuyến mại có mã giảm giá, 0 để get khuyến mại không có mã giảm giá. Mặc định lấy tất cả.
status tùy chọn Truyền value 1 để lấy thông tin các offers còn hoạt động, value 0 để lấy thông tin các offers hết hạn, và không truyền key này để lấy tất cả.

Mô tả kết quả

Key Mô tả
banners là 1 list chứa các dict banner, trong mỗi dict có: “link” - url banner, “width” - chiều rộng, “height” - chiều cao.
content Mô tả khuyến mại
id id khuyến mại
image url ảnh đại diện khuyến mại
link url khuyến mại
merchant owner khuyến mại
categories danh sách category của khuyến mại
name Tên khuyến mại
start_time Thời gian bắt đầu khuyến mại
end_time Thời gian kết thúc khuyến mại
domain Domain sản phẩm khuyến mại
aff_link Affiliate link

Ví dụ minh họa (Dùng tool Postman để call API)

offer_information.png

Top các sản phẩm bán chạy nhất

API response trả về (1 trong số 50 sản phẩm trả về)


{
  "total": 1,
  "data": [
    {
      "aff_link": "https://fast.accesstrade.com.vn/deep_link/4496607189591958814?url=https%3A%2F%2Fwww.topmot.vn%2Fcampaigns%2Farte-balo-sac-mau-ca-tinh%3Futm_source%3DAffiliate%26utm_medium%3DAccesstrade%26utm_campaign%3DArte%26utm_content%3DArte",
      "price": "1234",
      "discount": "1111",
      "brand": "",
      "category_id": "",
      "category_name": "Mobiles & Tablets",
      "desc": null,
      "image": "http://vn-live-01.slatic.net/p/2/image-4043672-333a3a442f18d22163d2aabde4760bb9-product.jpg",
      "link": "https://www.topmot.vn/campaigns/arte-balo-sac-mau-ca-tinh?utm_source=Affiliate&utm_medium=Accesstrade&utm_campaign=Arte&utm_content=Arte",
      "name": "ARTE - Balo Sắc Màu Cá Tính. Chỉ từ 199K",
      "product_category": "5",
      "product_id": "AP069ELAA1N898VNAMZ-2713903",
      "short_desc": null
    },
}

HTTP Request

GET https://api.accesstrade.vn/v1/top_products

Các biến params được truyền vào HTTP Request theo các cặp Key-Value, mở đầu chuỗi params bằng dấu “?” và giữa các biến phân tách nhau bằng dấu “&”. Vd: https://api.accesstrade.vn/v1/top_products?date_from=01-04-2016&date_to=01-05-2016

Query parameters

Biến params Required Mô tả
date_from tùy chọn Ngày filter bắt đầu, vd: ‘01-04-2016’
date_to tùy chọn Ngày filter cuối, vd: ‘01-01-2016’
merchant tùy chọn Đối tác, vd: lazada

Mô tả kết quả

Value Mô tả
category_id id danh mục sản phẩm
category_name tên danh mục sản phẩm
desc mô tả sản phẩm
image ảnh sản phẩm
link link sản phẩm
aff_link Affiliate link
price giá sản phẩm chưa sale
discount giá khuyến mại sản phẩm
total số lượng sản phẩm
name tên sản phẩm
product_id id sản phẩm

Ví dụ minh họa (Dùng tool Postman để call API)

top_products.png

Errors

Error Code Meaning
400 Bad Request – Your request sucks
401 Unauthorized – Your API key is wrong
403 Forbidden – This requested is hidden for administrators only
404 Not Found – The specified API could not be found
405 Method Not Allowed – You tried to access a API with an invalid method