# 到家簡介

本文檔提供了Zeek斑馬到家API的概述。商家可以通過 API 來請求配送服務,及獲得最新的配送狀態等。

使用Zeek斑馬到家API前,開發人員需要取得獲取 API 憑證: 「appid」和 「appsecret」。 API 憑證在接口請求中用到。如果開發人員希望在配送狀態更新時得到通知,開發人員可以提供運單跟踪回調URL。

# 對接環境

開發者可以使用以下 Zeek Open API 環境對接:

# Sandbox 環境

開發者可以在 Sandbox 環境進行 API 對接及測試。我們提供額外開發環境給定製化對接的客戶,請與我們團隊聯絡。

# Release 環境

Release 環境是正式運作的環境。

# 如何接入

在使用 Open API 接入到家配送服務時,一般需要經過以下的步驟:

# 1. 合作前期溝通

商家和Zeek 團隊商談合作事宜,包括服務使用模式、計費等等。

# 2. 提供商家資料

開發者需要開發者帳號才能使用 Open API。在開設帳號之前,商家需要為 Sandbox 和 Release 環境提供以下資料:

資料 說明
商家系統 IP Zeek 平台接口設有訪問 IP 限制,故此開發者需要提供商家系統的 IP 位址,以獲取接口訪問權限。
訂單狀態更新回調 URL 用來接受訂單狀態更新的 HTTP API。請參考 2D-API-1.5 運單跟踪態回調

# 3. 獲得開發者帳號

開發者將會獲得開發者帳號,包括在 Sandbox 和 Release 環境的以下資料:

  • App ID
  • App secret
  • API URL

# 4. 進行開發

開發者在 Sandbox 環境進行開發。可在API 接口說明 了解接口詳情。

# 5. 技術對接測試

在開發完成後,在 Sandbox 環境進行技術對接測試。

# 6. 營運測試

請與Zeek團隊商談營運測試安排

# 7. 服務上線

在經過技術對接和營運測試後,可以安排配送服務上線!