Skip to main content

Authorization

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

Apify

Prerequisites​

Before creating an Apify credential in Nexla, you need to obtain your API key from your Apify account. This credential authenticates Nexla with the Apify API and should be kept secure.

Obtain an Apify API Key​

  1. Sign in to your Apify account.

  2. Navigate to Settings in your Apify account to access the settings page.

  3. Locate the Integrations or API section in the settings menu. This section contains your API credentials and access tokens.

  4. Generate or copy your API Key. The API key is a secret token that authenticates API requests and provides access to your Apify account data. The API key is sent in the Authorization header as a Bearer token for all API requests.

    Your API key provides full access to your Apify account data through the API. Keep your API key secure and do not share it publicly or commit it to version control systems. If you suspect your API key has been compromised, regenerate it immediately in your Apify account settings. For detailed information about Apify API authentication, see the Apify API documentation.

Create an Apify Credential​

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

New Credential Overlay – Apify

ApifyCred.png

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 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 Configuration​

  1. Enter your Apify API key in the API Key Value field. This key authenticates Nexla with the Apify API and should match the API key obtained from your Apify account settings. The API key is sent in the Authorization header as a Bearer token for all API requests.

    The API key provides full access to your Apify account data through the API. Keep your API key secure and do not share it publicly or commit it to version control systems. Apify uses the API key in the Authorization header as a Bearer token for authentication, which allows Nexla to make authenticated requests to your account.

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.