Skip to main content

Authorization

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

Personio

Prerequisites​

Before creating a Personio credential, you need to obtain your Client ID and Client Secret from your Personio account. Personio uses token-based authentication, where your Client ID and Client Secret are used to obtain an API token that is then used for all subsequent API requests.

To obtain your Personio API credentials, follow these steps:

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

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

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

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

  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 Client ID will be displayed immediately after creation. Copy the Client ID.

  9. Your Client Secret will be displayed immediately after creation. Copy the Client Secret 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 Client ID and Client Secret are sensitive information and should be kept confidential.

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

Create a Personio Credential​

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

New Credential Overlay – Personio

PersonioCred.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​

Personio uses token-based authentication for all API requests. Your Client ID and Client Secret are used to authenticate with the Personio API authentication endpoint to obtain an API token, which is then used for all subsequent API requests.

  1. Enter your Personio Client ID in the Client ID field. This is the Client ID you obtained from your Personio account settings (Settings > Integrations > API or API Credentials section). The Client ID is used along with the Client Secret to authenticate with the Personio API authentication endpoint and obtain an API token.

  2. Enter your Personio Client Secret in the Client Secret field. This is the Client Secret you obtained from your Personio account settings. The Client Secret is used along with the Client ID to authenticate with the Personio API authentication endpoint and obtain an API token. The Client Secret is sensitive information and must be kept confidential.

    Your Personio API credentials can be found in your Personio account settings under Settings > Integrations > API or API Credentials section. The Client ID and Client Secret are used to authenticate with the Personio API authentication endpoint (/v1/auth) to obtain an API token. The API token is then automatically sent in the Authorization: Bearer {token} header for all subsequent API requests to the Personio API.

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

    For detailed information about Personio authentication, API access, and available endpoints, see the Personio 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.