Skip to main content

Authorization

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

Plytix

Prerequisites​

Before creating a Plytix credential, you need to obtain your API key and API password from your Plytix account. Plytix uses token-based authentication, where your API key and API password are used to obtain an access token that is then used for all subsequent API requests.

To obtain your Plytix API credentials, follow these steps:

  1. Sign in to your Plytix account using your administrator credentials.

  2. Navigate to your account settings or API management section in the Plytix interface.

  3. Look for the API or API Credentials section in your account settings, or navigate to Settings > API or Integrations > API.

  4. If you don't have API credentials yet, look for the option to create or view your API Key and API Password.

  5. Click Create API Credentials or Generate API Key to create new API credentials.

  6. Configure your API credentials:

    • Enter a name for the API credentials (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the credentials (if applicable)

  7. Click Create or Generate to create the API credentials.

  8. Your API Key will be displayed immediately after creation. Copy the API key.

  9. Your API Password will be displayed immediately after creation. Copy the API password immediately, as it may not be accessible again after you navigate away from the page.

  10. Store both credentials securely, as you will need them to configure your Nexla credential. The API key and API password are sensitive information and should be kept confidential.

The API key and API password are used to authenticate with the Plytix API authentication endpoint (/auth/api/get-token) to obtain an access token. The access token is then sent in the Authorization header with the Bearer prefix for all subsequent API requests to the Plytix API. The access token is automatically obtained and refreshed by Nexla as needed. If your credentials are compromised, you should immediately revoke them in your Plytix account settings and generate new ones. For detailed information about Plytix authentication, API access, and available endpoints, refer to the Plytix API documentation.

Create a Plytix Credential​

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

New Credential Overlay – Plytix

PlytixCred.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.

Token Authentication​

Plytix uses token-based authentication for all API requests. Your API key and API password are used to authenticate with the Plytix API authentication endpoint to obtain an access token, which is then used for all subsequent API requests.

  1. Enter your Plytix API key in the Access Token field. This is the API key you obtained from your Plytix account settings (Settings > API or API Credentials section). The API key is used along with the API password to authenticate with the Plytix API authentication endpoint and obtain an access token.

  2. Enter your Plytix API password in the API Password field. This is the API password you obtained from your Plytix account settings. The API password is used along with the API key to authenticate with the Plytix API authentication endpoint and obtain an access token. The API password is sensitive information and must be kept confidential.

    Your Plytix API credentials can be found in your Plytix account settings under Settings > API or API Credentials section. The API key and API password are used to authenticate with the Plytix API authentication endpoint (/auth/api/get-token) to obtain an access token. The access token is then automatically sent in the Authorization: Bearer {token} header for all subsequent API requests to the Plytix API.

    The access token is automatically obtained and refreshed by Nexla as needed. If your credentials are compromised, you should immediately revoke them in your Plytix account settings and generate new ones. The API key and API password provide access to your Plytix account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

    For detailed information about Plytix authentication, API access, and available endpoints, see the Plytix API documentation.

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.