Skip to content

How-to guide

API Key Connector

Configure a connector in 4 steps using an API key or personal access token. This guide covers each step of the configuration wizard.

2 min

At a glance

Configure a connector in 4 steps using an API key or personal access token. This guide covers each step of the configuration wizard.

Before you start

  • Access to an Ontologie workspace
  • API key or personal access token for the external service
  • (Optional) Target entity created in the ontology for linking

Steps

Step 1 : Choose the connector and enter credentials

From Live Data > Connectors, click the desired connector.

The configuration panel opens. Select API Key as the authentication method.

Enter your API key or token in the provided field.

API key configuration

Step 2 : Test the connection

Click Test connection to verify that Ontologie can connect to the source.

Test successful

If an error occurs, a message is displayed with details to help fix the issue.

Test error

Common errors

ErrorLikely causeSolution
401 UnauthorizedInvalid or expired API keyRegenerate the key in the provider's console.
403 ForbiddenInsufficient scopes or permissionsCheck the permissions of your key.
TimeoutService temporarily unavailableTry again in a few minutes.

Step 3 : Select data streams

After a successful test, Ontologie discovers the available streams from your source. Check the streams you want to synchronize.

Stream selection

Select the target entity in your ontology to receive the synchronized data.

Entity linking

Expected outcome

See also

Need help?

Write to us: Support and contact.