API endpoint: https://app-store-api.cyberbiz.io/ 。不論是哪個 CYBERBIZ 商家,API endpoint 都是相同的。

每秒至多 5 個 Request

使用 Bearer Token Access API

在 Request Header 中帶入 Access Token Authorization: Bearer {access_token got from /admin/oauth/token}

範例:

curl <https://app-store-api.cyberbiz.io/shop> \\
    -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2ODkxMzI0ODksImV4cCI6MTY4OTEzOTY4OSwic2hvcF9pZCI6NzEwOSwic2NvcGVzIjoicHVibGljIHNob3BfYXBpIiwic2hvcF9kb21haW4iOiJkZW1vLmN5YmVyYml6LmNvIn0.VyW3B2wA1b6uhH9pDfbzRvPjOmSQD7VHy-IiRmnof9g" \\
    -H "Accept: application/json"
curl <https://app-store-api.cyberbiz.io/v1/customers> \\
    -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2ODkxMzI0ODksImV4cCI6MTY4OTEzOTY4OSwic2hvcF9pZCI6NzEwOSwic2NvcGVzIjoicHVibGljIHNob3BfYXBpIiwic2hvcF9kb21haW4iOiJkZW1vLmN5YmVyYml6LmNvIn0.VyW3B2wA1b6uhH9pDfbzRvPjOmSQD7VHy-IiRmnof9g" \\
    -H "Accept: application/json"
curl <https://app-store-api.cyberbiz.io/v2/product_feeds> \\
    -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2ODkxMzI0ODksImV4cCI6MTY4OTEzOTY4OSwic2hvcF9pZCI6NzEwOSwic2NvcGVzIjoicHVibGljIHNob3BfYXBpIiwic2hvcF9kb21haW4iOiJkZW1vLmN5YmVyYml6LmNvIn0.VyW3B2wA1b6uhH9pDfbzRvPjOmSQD7VHy-IiRmnof9g" \\
    -H "Accept: application/json"

如何設定 APP 的 API scope ?

https://scribehow.com/shared/How_to_Configure_API_and_Webhook_Scopes_on_CyberBizio__APWDJkoLSO2XCNepOdNA-Q

APP API

[GET] /shop
[GET] /settings

Shop API

參考 API 文件內的 API 類型,例如 read_customers 可使用 customers 類型底下所有 Get API

Scope zh-TW en description
public 公開資料 public GET https://app-store-api.cyberbiz.io/v2/product_feeds
app 預設會有的 scope
read_products 讀取商品 read products read products, custom_collections, smart_collections, inventory_sync_groups , branch_store_inventory_update_status
write_products 修改商品 write products write products, custom_collections, smart_collections, inventory_sync_groups , batch_update_branch_store_inventory
read_customers 讀取會員 read customers read customers , custom_field_types , customer_tags
write_customers 修改會員 write customers write customers , custom_field_types , customer_tags
read_orders 讀取訂單 read orders read orders, periodic_orders , einvoices
write_orders 修改訂單 write orders write orders, periodic_orders , einvoices
read_affiliates 讀取分潤訂單 read affiliates **[**GET] /v2/affiliate_vendor_orders
read_discounts 讀取促銷 read discounts read discounts , add_buy_collections , shop_coupons , special_collections , vip_groups
write_discounts 修改促銷 write discounts write discounts , add_buy_collections , shop_coupons , special_collections , vip_groups
read_pos 讀取 POS read POS read pos_shops , stock_adjustments , stock_invoices , stock_receipts , stock_requisitions
write_pos 修改 POS write POS write pos_shops , stock_adjustments , stock_invoices , stock_receipts , stock_requisitions
read_branch_stores 讀取門市 read branch stores read branch_stores
write_branch_stores 修改門市 write branch stores write branch_stores
read_edms 獲取 EDM 資訊 read EDMs read edms
write_content 修改頁面內容 write content write pages assets/picture
read_content 取得頁面內容 read content read content assets/picture
customer_oauth OAuth 授權 customer_oauth write customer_oauth
read_shop_emails 讀取商店信箱 Read shop emails read shop.email shop.order_subscribes

V2 APIs

API Pagination 參數 (page, per_page, offset) 說明

API Pagination 參數 (page, per_page, offset) 說明