登入開始免費試用
easyCoexistence 官方 API

多租戶社交媒體 API:一個 API 密鑰,多個客戶帳戶

easyCoexistence 的 Partner API 以多租戶為設計原則:您帳戶上的一個 ec_live_ 密鑰,即可連接及管理多個客戶的 WhatsApp 號碼與社交帳戶。每個連接都帶有您客戶的 ID 作為 external_ref,持有該客戶自己的存取權杖,擁有獨立的 Webhook 端點,並會出現在已簽署的狀態事件中,因此 GET /channels?external_ref= 會列出單一客戶的帳戶。

200 characters

連接會話所能接受的最長 external_ref:您為客戶設定的自有 ID,會儲存於該會話所建立的連接上。

1 key

一個 easyCoexistence 帳戶同時持有的 API 密鑰數量;不同密鑰代表不同帳戶,帳單也分開計算。

50 open

一個帳戶可同時開啟的連接會話數量,另有每小時 100 個新會話的上限。

5 minutes

已簽署事件的時間戳記超過此時限即應拒絕,HMAC 須以常數時間比較。

一個帳戶如何服務多個客戶?

您的 easyCoexistence 帳戶代表您的產品,每個客戶則是其所帶來連接上的一個標籤。客戶無需自行建立帳戶、不會看到您的密鑰,並由您而非 easyCoexistence 向其收費:

Your accountOne ec_live_ key, one bill, one status events URL
Your customerYour own id, sent as external_ref
NumberA WhatsApp number at /connections
ChannelA social account at /channels
DestinationA webhook per number or channel

如何為每個連接標記您的客戶?

在連接會話中傳送 external_ref。該值會儲存於會話建立的號碼或頻道上,加入重新導向網址,並包含在其狀態事件中。Facebook 或 LinkedIn 登入若帶來多個專頁,每個專頁都會各自標記。如要查看單一客戶的帳戶,請篩選任一清單:

One customer's social accounts and numbers
curl "https://easycoexistence.com/api/v1/channels?external_ref=customer_4821" \
  -H "Authorization: Bearer $EC_API_KEY"

curl "https://easycoexistence.com/api/v1/connections?external_ref=customer_4821" \
  -H "Authorization: Bearer $EC_API_KEY"

客戶的存取權杖如何分開保存?

每個連接持有其所屬客戶自己的存取權杖。WhatsApp 號碼的存取權杖,是 Meta 在 Embedded Signup 時發出的商業權杖,範圍限於該客戶的資產;社交帳戶的存取權杖,則是其擁有者所授予的權杖。憑證只能透過您的密鑰、從您的後端取得,若某個 ID 不在您的帳戶上,則會回傳 404 not_found。在取得存取權杖之前,請先查找某項工作所屬客戶的連接,確保一個租戶的工作不會在另一個租戶的帳戶上執行。

Webhook 如何按客戶運作?

每個帳戶的端點由您選定,每個帳戶只有一個。您可以將頻道指向同一個網址,再依請求主體中的 account_id 分派;或為每個客戶設定專屬網址。每個頻道都以 PUT /channels/{id}/webhook 設定的自有密鑰簽署,因此 account_id 會告訴您應使用哪個密鑰驗證。號碼的訊息由 Meta 傳送至 webhook_url,該網址設於 WhatsApp Business Account 上,因此需依 phone_number_id 分派。

狀態事件如何說明其所屬客戶?

透過帶上您的 external_ref。每個帳戶的一個事件網址會接收 connection.* 與 channel.* 事件,每個事件內含連接或頻道的檢視,包括 external_ref;post.published 與 post.failed 則會附上貼文及其頻道。事件以帳戶自有的密鑰在 X-EC-Signature 中簽署,若您的端點失敗便會重試,因此每個投遞 ID 只需處理一次。

您可以多快為多個客戶完成導入?

每個帳戶可同時開啟 50 個連接會話,每小時新建 100 個。Meta 會對每次首次 WhatsApp 導入計算一個應用程式層級的上限,該上限由所有 easyCoexistence 帳戶共用,而這些限制可防止某一平台的匯入耗盡該上限。請在客戶即將連接時才建立會話;若觸及上限,系統會回傳 429 cap_reached 或 rate_limited。

如果客戶的帳戶已在其他地方連接,怎麼辦?

登入會被拒絕。一個社交帳戶同一時間只能透過一個 easyCoexistence 帳戶連接;若另一個使用 easyCoexistence 的服務已持有該帳戶,會話的 last_error 會註明此情況,客戶需在該處移除連接,或改用其他帳戶登入。在您自己的帳戶內,客戶可以連接任意數量的帳戶,每個帳戶都標記相同的 external_ref。

如何移除單一客戶?

依 external_ref 列出其連接與頻道,並逐一以 DELETE 刪除。移除號碼會撤銷 easyCoexistence 在 Meta 的存取權並停止監察;移除頻道則會在網絡層面撤銷存取權,並取消仍在佇列中等待發布的貼文。每項的收費會在當期結束時停止,該客戶的其他連接,以及其他租戶的連接,均不受影響。

常見錯誤

  • 以電郵作為 external_ref。電郵會變更,而該值儲存於每個連接上,因此請使用您自己資料庫中的穩定 ID。
  • 以錯誤租戶的密鑰驗證轉發的事件。請依請求主體中的 account_id 查找密鑰,因為每個頻道都以自己的密鑰簽署。
  • 一次過向全部客戶發送連接連結。每個帳戶只能開啟 50 個會話,因此請分批邀請客戶。
  • 只在您自己的資料庫中刪除客戶。其連接仍留在您的帳戶上,並計入您的帳單,直到每個連接都透過 API 移除為止。
使用 EasyCoexistence 完成這項設定

easyCoexistence 讓一個 API 密鑰服務您全部的客戶:他們的 WhatsApp 號碼,以及 Instagram、Facebook、TikTok、YouTube、LinkedIn 等帳戶與更多頻道,每項都標記您的客戶 ID,並配備各自的存取權杖、Webhook 與已簽署事件,每個連接均獲 24/7 全天候監察。每個連接每月由 US$ 9 降至 US$ 0.75,連接越多單價越低,並提供首 3 天免費試用。

常見問題

每位客戶是否需要一個 easyCoexistence 帳戶?

不需要。一個帳戶及其密鑰可容納多位客戶的連接,並以 external_ref 區分。只有在您需要分開計費時,才需要獨立帳戶。

客戶之間能否看到彼此的帳戶?

透過 easyCoexistence 不能。客戶不持有您的密鑰,僅能開啟其各自的連接連結。客戶在您的產品內看到什麼,由您的程式碼決定。

我能否為每位客戶設定不同的 Webhook 網址?

可以。每個號碼及每個頻道都可設定各自的端點,因此既可使用專屬客戶網址,也可使用一個共用網址,再依 account_id 分派。

多租戶帳戶如何計費?

按您全部客戶的連接總數合併計費:每個連接每月由 US$ 9 降至 US$ 0.75,依您連接總數所屬的級別而定,並提供首 3 天免費試用。

繼續閱讀

兩分鐘內連接您的第一個頻道。

無需等待平台審核。連接 WhatsApp、Instagram、TikTok 或其他頻道,然後請您的 AI 發佈貼文、回覆訊息或匯報數據,並看着它運作。

  • 免費試用 3 天
  • 隨時取消
  • 只用官方 API
  • 24/7 監察

驗證日期