gepardio/connectors-sdk

SDK to simplify building connectors for Gepard SaaS Platform

0.2.0 2022-09-01 14:32 UTC

Requires

• php: >=8.1.0
• beberlei/assert: ^3.3
• league/config: ^1.1
• psr/log: ^1.1 || ^2.0 || ^3.0

Requires (Dev)

• guzzlehttp/guzzle: ^7.4
• phpstan/phpstan: ^1.7
• phpunit/phpunit: ^9.5
• symfony/dotenv: ^6.0

Apache-2.0

• Gepard Development Team

• product
• taxonomy
• sdk
• Gepard

README

The Connectors SDK makes it easy for developers to create an integration with PIM, Marketplace or any custom source of product content to deliver it into Gepard SaaS Platform for further processing.

Glossary

Connector - a set of "commands" and "queries" with settings that defines how to access any external source to retrieve and/or update data.

Query - a connector operation intended to retrieve data from external source and convert it to supported data transfer object(s). Example: download products and convert them to save them on Gepard SaaS Platform.

Command - a connector operation intended to process data from payload, convert it and send to external source. Example: upload products from Gepard SaaS Platform, convert them to save them in external system.

Getting started

1. Take a look to existing integration tests for examples how to use this library.

2. Create own connector definition class by extending \GepardIO\ConnectorsSDK\Connector class. If there are any settings that your connector require for its work - they should be defined and returned in getSettings() method. Examples of such "global" settings: credentials to access some API, API hostname, etc.

3. Create necessary query and/or command classes. Do not forget to add their class names to corresponding methods in connector (getQueries() and getCommands()).

4. Create GitHub repository with your integration and let us know that we can add new integration on our platform.

Resources

• Issues - Report issues, submit pull requests, and get involved.
• Changelog - List of changes.