Skip to main content

Configuring Your Connector

Once your Connector is built, the next step is to connect it to SyncHive.

Let's keep building on our example of connecting SyncHive with Shopify. To do this, we'll introduce a Shopify Connector and a Shopify Integration to SyncHive. The Shopify Connector lets SyncHive know that we'll be working with the Shopify platform, while the Shopify Integration specifies the particular Shopify store we want to connect with.

1. Adding your Connector to SyncHive​

Log in to the SyncHive app and navigate to the Connectors page. Click the Add Connector button to begin. Follow the on-screen instructions to configure your Connector. We'll guide you through the setup steps below.

Connector information:​

In this step, we'll enter the essential details needed to create your Connector in SyncHive. We recommend selecting a name for your Connector that clearly indicates the platform it connects to.

Example Configuration:

  • Name: ShopifyConnector
  • Key: shopify_connector
  • Schema: limber
  • Status: Enabled
  • Version: 1.0.0
  • Group: ECommerce
  • External Contact Type: HTTP Endpoint

Connector Contact:​

Next, we'll set up the Connector Contact information. This configures how SyncHive will authenticate and communicate with your Connector.

Example Configuration:

  • Contact Type: HTTP Endpoint
  • HTTP URL: https://www.my_connector_url.com
  • HTTP API Key: Yes
  • HTTP API Key Header: X-Shopify-Connector-Key
  • HTTP API Key Value: 9XnZr4JmPWTVHuyFBheg
  • Contact Format: JSON Document
  • Auth Type: None

Connector Registration:​

Now, let's set up the Connector Registration. This step defines how your Connector will authenticate and communicate with SyncHive.

Example Configuration:

  • Registration Type: API Key
  • API Key Header: X-Shopify-Connector-Key
  • API Key Value: 9XnZr4JmPWTVHuyFBheg

Connector Shapes:​

We'll be exchanging product-related information between SyncHive and Shopify. To enable this, edit the Product shape on the screen and configure it as follows:

  • Inbound Status: Enabled
  • Check Request Type: Last Check Time
  • Allow Update Polling: No
  • Allow Update Notification: Yes
  • Outbound Status: Enabled

Connector Properties:​

For now, let's skip this step to keep things simple.

Connector complete:​

Awesome! You've set up your Connector in SyncHive. Let's exit the Connector creation process and move on to configuring an Integration.

2. Adding a Test Integration to SyncHive​

Navigate to the Integrations page and click the Add Integration button to begin. Follow the on-screen instructions to configure your Integration. We'll guide you through the setup steps below.

Integration information:​

Just like when we set up your Connector, we'll now enter the key details needed to create your Integration in SyncHive.

Example Configuration:

  • Name: ShopifyNzIntegration
  • Key: shopify_nz_integration
  • Connector Key: ShopifyConnector
  • Status: Enabled
  • Version: 1.0.0
  • Group: ECommerce

Integration Contact:​

Next, we'll configure the Integration Contact information. This info will be requested by your Connector when SyncHive calls your Connector API, helping to identify the destination system and how to authenticate with it.

Example Configuration:

  • Contact Type: HTTP Endpoint
  • HTTP URL: https://www.my_shopify_url.com
  • HTTP API Key: Yes
  • HTTP API Key Header: X-Shopify-Access-Token
  • HTTP API Key Value: 3tuCsUi3zopbxWmuqFDe
  • Contact Format: JSON Document
  • Auth Type: None

Integration Shapes:​

It's time to configure the Product Shape for this Integration. Edit the Product shape and set it as follows:

  • Mode: Live
  • Inbound Status: Enabled
  • Inbound Update Type: Event
  • Check Frequency: Never
  • Inbound Filter Status: Disabled
  • Outbound Status: Enabled
  • Outbound Filter Status: Disabled

Integration Properties:​

For now, let's skip this step to keep things simple.

Integration complete:​

Congratulations! You've set up your Connector and a test Integration in SyncHive. You're all set to begin using your Connector to communicate with SyncHive.