多租户社交媒体 API:一个 API 密钥,管理众多客户的账户
easyCoexistence 的 Partner API 在设计上即支持多租户:您账户上的一个 ec_live_ 密钥即可连接并管理众多客户的 WhatsApp 号码和社交账户。每个连接都带有您客户的 id 作为 external_ref,持有该客户自己的访问令牌,拥有独立的 Webhook 接收地址,并出现在带签名的状态事件中,因此 GET /channels?external_ref= 可列出某一位客户的全部账户。
连接会话接受的最长 external_ref:您自己为客户设定的 id,存储在它所创建的连接上。
一个 easyCoexistence 账户同时持有的 API 密钥数量;不同密钥意味着不同账户和不同账单。
一个账户同时可保持打开的连接会话数,另加每小时 100 个新会话的上限。
签名事件的时间戳超过此时长后应被拒绝,并以恒定时间比较 HMAC。
一个账户如何服务众多客户?
您的 easyCoexistence 账户代表您的产品,每位客户则是其所带来连接上的一个标签。客户无需创建自己的账户,也看不到您的密钥,并由您而非 easyCoexistence 向其收费:
如何为每个连接标记您的客户?
在连接会话上发送 external_ref。该值会存储在会话创建的号码或渠道上,添加到重定向中,并包含在其状态事件内。若一次 Facebook 或 LinkedIn 登录带来多个主页,则会分别为每个主页添加标记。要查看某位客户的账户,请筛选以下任一列表:
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 如何运作?
每个账户一个接收地址,由您选择。您可以将所有渠道指向同一个 URL,并根据正文中的 account_id 进行路由,也可以为每位客户设置各自的 URL。每个渠道使用其在 PUT /channels/{id}/webhook 中设置的独立密钥进行签名,因此 account_id 会告诉您应使用哪个密钥进行验证。号码的消息由 Meta 发送到其 webhook_url,该地址在 WhatsApp Business Account 上设置,因此需按 phone_number_id 进行路由。
状态事件如何说明它们涉及哪位客户?
通过携带您的 external_ref。每个账户一个事件 URL,接收 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 让一个 API 密钥服务您的全部客户:他们的 WhatsApp 号码,以及 Instagram、Facebook、TikTok、YouTube 和 LinkedIn 账户,以及更多渠道。每个连接都带有您的客户 id,拥有独立的访问令牌、Webhook 和带签名的事件,并且全天候 24/7 监控。每个连接每月 US$ 9 至 US$ 0.75,连接越多价格越低,前 3 天免费试用。
常见问题
我需要为每位客户各开一个 easyCoexistence 账户吗?
不需要。一个账户及其密钥可以持有多位客户的连接,并通过 external_ref 加以区分。只有当您希望分开计费时,才需要独立的账户。
我的客户能看到彼此的账户吗?
在 easyCoexistence 中不能。他们从不持有您的密钥,只打开属于自己的连接链接。每位客户在您的产品中能看到什么,由您的代码决定。
我能为每位客户设置不同的 Webhook URL 吗?
可以。每个号码和每个渠道都可设置自己的接收地址,因此既可以使用客户专属 URL,也可以使用一个由 account_id 路由的共享 URL。
多租户账户如何计费?
按您所有客户合计的连接数计费:每个连接每月 US$ 9 至 US$ 0.75,由您的总数量所在档位决定,前 3 天免费试用。
继续阅读
两分钟连接您的第一个渠道。
无需等待平台审核。连接 WhatsApp、Instagram、TikTok 或其他渠道,然后让您的 AI 发布、回复或生成报告,看它如何运作。
- 免费试用 3 天
- 随时取消
- 仅使用官方 API
- 全天候 24/7 监控
验证时间