Skip to main content

Authorization

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

Namely

Prerequisites​

Before creating a Namely credential, you need to obtain your Personal Access Token (PAT) and company name from your Namely account. Namely uses Personal Access Token authentication for all API requests, with the PAT sent in the Authorization header with the Bearer prefix.

To obtain your Namely API credentials, follow these steps:

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

  2. Navigate to your account settings or profile settings in the Namely interface.

  3. Look for the API or Personal Access Tokens section in your account settings.

  4. If you don't have a Personal Access Token yet, click Generate Token or Create Personal Access Token to create a new PAT.

  5. Configure your Personal Access Token settings:

    • Enter a name or description for the token (e.g., "Nexla Integration")
    • Set the expiration time (PATs have a longer expiration time of 2 years by default)
    • Review and select the permissions or scopes for the token

  6. Click Generate or Create to create the Personal Access Token.

  7. Copy the Personal Access Token immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  8. Identify your company name. This is the subdomain used in your Namely URL. For example, if your Namely URL is https://acme.namely.com, your company name is acme. You can find this in your Namely URL or in your account settings.

  9. Store both the Personal Access Token and company name securely, as you will need them to configure your Nexla credential. The Personal Access Token is sensitive information and should be kept confidential.

The Personal Access Token is sent in the Authorization header with the Bearer prefix (e.g., Authorization: Bearer {pat}) for all API requests to the Namely API. The company name is used to construct API endpoint URLs specific to your Namely instance (e.g., https://{company}.namely.com/api/v1/profiles/me). The PAT authenticates your requests and grants access to Namely resources based on your account permissions and the token's scopes. If your Personal Access Token is compromised, you should immediately revoke it in your Namely account settings and generate a new one. For detailed information about Personal Access Tokens, API authentication, and available endpoints, refer to the Namely API documentation.

Create a Namely Credential​

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

New Credential Overlay – Namely

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

Personal Access Token Authentication​

Namely uses Personal Access Token (PAT) authentication for all API requests. The PAT is sent in the Authorization header with the Bearer prefix to authenticate API requests to the Namely API.

  1. Enter your Namely Personal Access Token in the Personal Access Token field. This is the PAT you obtained from your Namely account settings (API or Personal Access Tokens section). The Personal Access Token is sent in the Authorization: Bearer {pat} header for all API requests to the Namely API. The Personal Access Token is sensitive information and must be kept confidential.

  2. Enter your Namely company name in the Company Name field. This is the subdomain used in your Namely URL. For example, if your Namely URL is https://acme.namely.com, your company name is acme. The company name is used to construct API endpoint URLs specific to your Namely instance (e.g., https://{company}.namely.com/api/v1/profiles/me). You can find this in your Namely URL or in your account settings.

    Your Namely Personal Access Token can be found in your Namely account settings under the API or Personal Access Tokens section. Personal Access Tokens are easier to create and use than OAuth applications and have a longer expiration time of 2 years. The Personal Access Token is sent in the Authorization: Bearer {pat} header for all API requests to the Namely API.

    Your company name is the subdomain used in your Namely URL. For example, if your Namely URL is https://acme.namely.com, your company name is acme. The company name is used to construct API endpoint URLs specific to your Namely instance.

    If your Personal Access Token is compromised, you should immediately revoke it in your Namely account settings and generate a new one. The Personal Access Token provides access to your Namely account data and should be treated as sensitive information. Keep your Personal Access Token secure and do not share it publicly.

    For detailed information about Personal Access Tokens, API authentication, and available endpoints, see the Namely 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.