如果您正在构建一个连接到 Omnisend 的应用程序,请按照以下步骤了解 API,选择身份验证方法,完成集成,并提交审核。
💡 本文重点关注合作伙伴旅程。有关实施细节,请使用 Omnisend API 文档。
开始之前
定义您的应用程序将如何使用 Omnisend 数据。例如,您的应用程序可能会:
同步联系人。
检索产品。
发送触发自动化工作流的事件。
Omnisend 是一个自助服务平台。您无需请求单独的沙盒帐户进行开发或测试。
创建一个常规的 Omnisend 帐户,并在开发集成时使用测试数据。您可以通过标准的 Omnisend 注册流程创建帐户。
提交过程
步骤 1. 查看 Omnisend API 文档
从 创建您自己的应用程序 开始。本指南解释了 Omnisend 应用程序的结构以及所需的步骤。
接下来,查看 快速入门指南。它涵盖了您在开发中所需的 API 基础知识,包括身份验证、端点和请求格式。
识别您的应用程序所需的 API 资源:
继续之前,请记录:
您的应用程序将发送到 Omnisend 的内容。
您的应用程序将检索的内容。
它需要哪些权限。
请求失败时应发生什么。
步骤 2. 选择身份验证方法
根据用户如何连接您的应用程序,在 API 密钥和 OAuth 之间进行选择。
💡 对于多个商家将连接的公共应用程序, Omnisend 推荐使用 OAuth。OAuth 为每个用户提供授权流程,而不是要求他们手动创建和共享 API 密钥。
要实现 OAuth,请遵循 OAuth 身份验证说明。然后,提交 OAuth 凭据请求表单。
提供表单中请求的信息。Omnisend 将提供您继续所需的凭据和信息。
步骤 3. 构建和测试您的集成
使用常规的 Omnisend 帐户构建和测试您的集成。使用测试数据并在 商店设置 → API 日志 中查看结果。使用 API 日志调试请求并确认数据是否正确传递。
测试完整的用户体验,包括:
授权。
数据同步。
请求失败。
断开连接。
重新连接。
如果您的应用程序发送联系人、订单、产品、购物车或事件,请验证每个资源是否按您的应用市场列表中所描述的行为。
步骤 4。提交您完成的应用程序
在您实现和测试您的集成后,完成 应用市场提交表单。
包括表单中请求的信息,例如:
应用程序名称。
应用程序描述。
类别。
网站。
徽标。
设置说明。
支持联系人。
身份验证方法。
请求的权限。
测试信息。
如果表单请求屏幕截图、测试凭据、隐私信息或安全详细信息,请在提交时提供它们。这有助于 Omnisend 测试您的应用。
步骤 5。了解审核流程
提交表单后,Omnisend 将审核您的集成和提议的应用市场列表。
审核检查是否:
该应用程序按描述工作。
应用程序是否适当地使用请求的权限。
列表是否提供了清晰的设置说明。
如果信息缺失或您的集成需要更改,Omnisend 可能会联系您。
如果请求更改,请根据审核团队的指示更新应用或列表。
集成通过审核后:
Omnisend 可以批准并在应用市场发布该列表。用户可以浏览该列表并连接应用。
Omnisend 还会撰写一篇专门的支持文章,解释商家如何将您的应用与 Omnisend 集成。
步骤 6。发布后维护您的应用
发布后保持您的集成最新。在发布重大更改之前审查您的权限,并保持您的支持联系信息最新。
如果您计划改善集成,请告知 Omnisend,以便更新相关的支持内容。
常见问题
我应该使用 API 密钥还是 OAuth?
根据用户如何连接您的应用选择身份验证方法。建议公共应用使用 OAuth,以便多个用户使用。
我应该在应用市场提交中包含哪些信息?
提供提交表单中请求的信息,包括您的应用名称、描述、类别、网站、徽标、设置说明、支持联系、身份验证方法、请求的权限和测试信息。
需要 Omnisend 的帮助吗? 通过应用内聊天或电子邮件联系我们的支持团队[email protected]。我们的团队全天候 24/7 可用。
