Set Up an HTTP API Connector

This guide explains how to set up an HTTP API connector that external systems can call to send or retrieve data.

Overview

An HTTP API connector exposes an endpoint that external systems can call. This allows external systems to both send data to and retrieve data from YuzeData through a controlled API.

Use Case	Description
Webhooks	Receive event notifications from external systems
Data exposure	Let external systems query and retrieve data from YuzeData
API facade	Expose a clean, modern API that hides legacy system complexity

When to Use This Guide

Use this guide when external systems need to interact with YuzeData via HTTP. The external system initiates the connection and sends HTTP requests to your connector endpoint — either to send data or retrieve it.

For connectors where YuzeData pulls data from external systems on a schedule, deploy a connector in Direct mode instead.

Prerequisites

Before setting up an HTTP API connector, ensure you have:

1. A connector template that supports HTTP API mode
2. The external system's webhook configuration access (if applicable)

Step 1: Deploy the Connector

1. Navigate to Integrations → Connectors
2. Click Deploy Connector
3. Select a connector template that supports HTTP API mode
4. Configure the connector settings
5. Enable HTTP API mode
6. Click Deploy

After deployment, YuzeData generates an endpoint URL for the connector.

Step 2: Create an API Client

External systems authenticate using an API client. Create one if you don't have one already:

1. Navigate to Company
2. Go to the API Clients tab
3. Click Create API Client
4. Configure the authentication strategy
5. For OAuth2 authentication:
   • Create a client secret with your desired expiration period
   • Options: 1 month, 3 months (default), 6 months, 1 year, or never

   • Security Recommendation

     Choose an expiration period that balances security and operational convenience. Avoid "never" for production secrets as regular rotation reduces security risks.

   • Store the secret securely - it's only shown once

Step 3: Grant Connector Access

Allow the API client to access your connector:

1. Open the API client details
2. Go to Connector Access
3. Add the HTTP API connector
4. Save changes

Step 4: Configure the External System

Configure your external system to send requests to YuzeData:

1. Copy the connector's endpoint URL from YuzeData
2. In the external system, configure the webhook/callback URL
3. Set up authentication based on your chosen strategy:

For OAuth2:

• Configure the token endpoint
• Add the Client ID and Client Secret
• Set the Authorization header with the access token

For Webhook Signatures:

• Configure the shared secret
• Enable request signing with the correct algorithm

Troubleshooting

Request rejected (401 Unauthorized)

• Verify the API client credentials are correct
• Check that the API client has access to the connector
• For OAuth2, ensure the access token is not expired
• Check if the client secret itself has expired - create a new one if needed

Request rejected (403 Forbidden)

• Verify the API client has the required scopes
• Check that connector access is granted

Signature validation failed

• Verify the shared secret matches on both sides
• Check the signature algorithm matches
• Ensure the signature header name is correct