SyncBox is built around the concept of API Connectors, which act as bridges between SyncBox and your data sources. Each API Connector allows SyncBox to establish a connection with a specific data source, enabling it to either read data from or write data to that source, depending on its nature.


What is an API Connector?

An API Connector is a configurable entity within SyncBox that contains all the necessary details required to communicate with a data source. These connectors serve as the foundation for defining synchronization workflows between systems. By leveraging API Connectors, SyncBox can integrate with a wide range of data sources, from databases to web APIs and beyond.


Key Components of an API Connector

To function effectively, each API Connector must be configured with the following details:

  • Data Source Address
    The endpoint or address of the data source. This could be a URL for a web API, a connection string for a database, or another type of identifier.

  • Credentials
    Authentication details needed to access the data source securely. Depending on the source, this may include:

    • API keys
    • Username and password
    • OAuth tokens
    • Certificates or other security credentials

  • Access Type
    Depending on the data source's capabilities, an API Connector can be configured to:

    • Read: Extract data from the source.
    • Write: Push data to the source.
    • Read and Write: Perform both actions, if supported.


How API Connectors Work

When you configure an API Connector, SyncBox stores the provided information securely and uses it to establish a connection to the data source when executing a synchronization process. The flexibility of API Connectors allows SyncBox to interact with various systems, ensuring a smooth data flow between them.


Example Use Cases

  1. Customer Relationship Management (CRM): SyncBox connects to a CRM API to retrieve customer data and sync it with another system.
  2. Enterprise Resource Planning (ERP): Write inventory updates from an external source to an ERP system.
  3. Cloud Storage Services: Read and write files to a cloud storage API for document synchronization.

By carefully configuring your API Connectors, you ensure that SyncBox can reliably communicate with your data sources, laying the groundwork for efficient and accurate data synchronization.