Skip to main content

API Key Connector

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 a 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

Warning
Never share your API key in source code or shared documents.

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

Tip
Start with one or two streams, then add more if needed. Each stream generates a tab in the source-linked spreadsheet.

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

Entity linking

Tip
You can also link the source later from the Sources tab of the entity in the ontology.

Expected outcome

Active connector
Synchronization starts and data appears in the source-linked spreadsheet of the target entity.

See also

Need help?

Write to us: Support and contact.