Skip to main content

Authorization

Follow this guide to create a new People.ai credential that will allow Nexla to authenticate to and exchange data with your People.ai account.
people_ai_api_auth.png

People.ai

Prerequisites​

To connect Nexla to People.ai, you need a People.ai API key. API keys are generated from within the People.ai platform by an administrator and are sent via the X-API-Key request header on every call to the People.ai API.

Obtain a People.ai API Key​

People.ai API keys are managed in the platform settings. Contact your People.ai administrator or reach out to People.ai Support to request an API key if you do not have one. People.ai may also provide API keys as part of onboarding or integration setup.

  1. Sign in to your People.ai platform account at https://app.people.ai.

  2. Navigate to Settings in the left navigation panel.

  3. Locate the API Keys or Integrations section within Settings.

  4. Generate a new API key and copy it immediately for safekeeping. Store the key securely, as it grants access to your People.ai data.

Important

Treat your People.ai API key as a password. Do not share it in publicly accessible locations such as source control repositories, chat messages, or emails.

Determine Your API Environment​

People.ai provides three API environments. Use the environment that matches your deployment:

  • Production (https://api.people.ai/v0/public) — For live, production data. This is the default and most commonly used environment.
  • Staging (https://api-staging.people.ai/v0/public) — For testing integrations against a staging instance before deploying to production.
  • Mock (https://api-mock.people.ai/v0/public) — For development and testing without affecting real data.

The Production environment is selected by default in Nexla. Only change the Base URL if you specifically need to connect to the People.ai Staging or Mock environment.

Create a People.ai Credential​

  • To create a new People.ai credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Settings​

  1. Enter your People.ai API key in the API Key field. This key authenticates Nexla with the People.ai API and is sent as the X-API-Key header on every request. Keep this value secure and do not share it with unauthorized users.

  2. Select the Base URL for the People.ai API environment you want to connect to from the dropdown menu. The available options are:

    • Production — Connects to https://api.people.ai/v0/public, the live People.ai environment. Select this option for all standard data integration workflows.

    • Staging — Connects to https://api-staging.people.ai/v0/public, a non-production environment used for testing integrations before promoting them to production.

    • Mock — Connects to https://api-mock.people.ai/v0/public, a mock API environment suitable for development and automated testing without affecting real data.

    The Base URL defaults to the Production environment. Select Staging or Mock only if your People.ai account and the data you need reside in one of those environments.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.