gepardio/connectors-sdk

简化构建Gepard SaaS平台连接器的SDK

0.2.0 2022-09-01 14:32 UTC

This package is auto-updated.

Last update: 2024-09-29 06:20:30 UTC


README

连接器SDK使开发者能够轻松创建与PIM、市场或任何自定义产品内容源集成的连接,并将其传输到Gepard SaaS平台以进行进一步处理。

术语表

连接器 - 一组“命令”和“查询”,包含设置,用于定义如何访问任何外部源以检索和/或更新数据。

查询 - 用于从外部源检索数据并将其转换为支持的数据传输对象的连接器操作。例如:下载产品并将它们转换为在Gepard SaaS平台上保存。

命令 - 用于从有效载荷中处理数据,将其转换为并发送到外部源的连接器操作。例如:从Gepard SaaS平台上传产品,将其转换为在外部系统中保存。

入门

  1. 查看现有的集成测试示例,了解如何使用此库。

  2. 通过扩展\GepardIO\ConnectorsSDK\Connector类创建自己的连接器定义类。如果您的连接器需要任何工作所需的设置,则应在getSettings()方法中定义和返回。此类“全局”设置的示例包括访问某些API的凭据、API主机名等。

  3. 创建必要的查询和/或命令类。不要忘记将它们的类名添加到连接器中的相应方法(getQueries()getCommands())。

  4. 创建包含您的集成的GitHub存储库,并让我们知道我们可以在我们的平台上添加新的集成。

资源

  • 问题 - 报告问题、提交拉取请求并参与其中。
  • 变更日志 - 变更列表。