跳到主内容
English (United States) Español (España)

在哪里查看 Mirakl API 文档

  • 更新

 

本文说明在哪里查看 Mirakl API 官方文档，以及每个 API 技术页面通常包含哪些信息。

重要：API 需要技术知识，或需要你的集成团队协助。在开发连接之前，请始终查看 Mirakl 官方文档。
内容
  1. API 文档有什么用途
  2. 如何从 Mirakl 进入
  3. Mirakl 官方资源
  4. 如何搜索具体 API
  5. API 页面包含哪些信息
  6. 通过 API 集成前需要检查什么
  7. 总结
1️⃣ API 文档有什么用途

Mirakl API 可以帮助你的系统与 Marketplace 平台之间自动化处理流程。

你可以使用 API 查询或更新报价、订单、文件、发票或官方文档中提供的其他流程信息。

2️⃣ 如何从 Mirakl 进入

在 Mirakl 中，你可以通过屏幕右上角的 help 图标 进入帮助内容。

  1. 登录你的 Mirakl 卖家账户。
  2. 选择右上角的 help 图标。
  3. 使用搜索栏查找 API 相关文档。
  4. 打开对应结果，并查看技术信息。
请注意：部分技术内容可能需要登录，或需要具备特定权限。
3️⃣ Mirakl 官方资源

你可以通过以下资源查看官方文档：

请记住：如果你需要查看卖家可用的全部 API，请使用 Seller APIs 索引。不要把某个具体 API 的 URL，例如 offers、orders 或 invoices，当作通用 API 索引使用。
4️⃣ 如何搜索具体 API

如果你需要查找某个具体 API，请使用 Mirakl Help Center 或 Developer Portal 的搜索栏。

  1. 进入 Help Center 或 Developer Portal。
  2. 输入你想自动化的流程。
  3. 筛选或查看与 Seller APIs 相关的结果。
  4. 打开对应 API，并查看完整文档。

你可以搜索以下关键词：

  • Offers，用于处理报价。
  • Orders，用于处理订单。
  • Documents，用于处理文件。
  • Accounting，用于查看可通过 API 获取的财务信息。
  • Invoices，用于处理可用的发票相关流程。
5️⃣ API 页面包含哪些信息

信息会根据 API 不同而变化，但通常会包含以下内容：

  • API 编号或名称：该操作的技术标识，例如 orders、offers 或 documents。
  • 说明：解释该 API 的用途。
  • 调用频率：如有定义，会显示推荐使用频率和使用限制。
  • Endpoint：集成需要调用的技术路径。
  • Method：调用类型，例如 GET、POST、PUT 或 DELETE。
  • Pagination：当 API 返回大量记录时，如何翻页读取结果。
  • Parameters：请求中可以发送的筛选条件或字段。
  • Response fields：API 返回的数据结构。
  • Allowed values：允许使用的状态、代码或枚举值。
  • Examples 或 schemas：用于帮助实现的请求示例或响应结构。
  • Technical notes：关于废弃字段、本地化、权限或推荐替代方案的提示。
Mirakl API 技术页面示例

示例图片：图片中显示的 API 可能不是你需要实现的 API。请仅将其作为技术文档展示方式的视觉参考。

重要：请始终确认该 API 是否属于 Seller 环境，以及是否适用于你想自动化的操作。并非所有 API 都适用于所有用户类型或权限。
6️⃣ 通过 API 集成前需要检查什么

在开发集成之前，请检查以下内容：

  • 目标：明确你想自动化哪个流程。
  • 权限：确认你的用户或集成可以访问所需信息。
  • 凭证：安全管理密钥或访问 token。
  • 环境：确认你使用的是测试环境还是生产环境。
  • 数据量：检查 API 是否建议在大数据量场景下使用异步导出。
  • 错误处理：准备好错误处理、重试机制和日志记录。
安全：不要通过邮件、消息或不安全渠道共享密钥、token 或凭证。如有疑问，请先咨询你的技术团队。
7️⃣ 总结
  • Mirakl 帮助入口位于右上角：从平台的 help 图标进入。
  • 始终使用官方文档：Help Center、Developer Portal 和 Seller APIs 索引。
  • 每个 API 可能包含不同技术信息： endpoint、method、频率、参数、分页、响应和示例。
  • 需要技术支持：API 需要开发、测试以及安全的凭证管理。
  • 避免把某个具体 API 当作通用索引： 请始终在 Seller APIs 索引或官方搜索工具中查找。

 

相关文章