Skip to main content

Authorization

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

LinkSquares

Prerequisites​

To connect Nexla to the LinkSquares API, you will need a LinkSquares API key. LinkSquares API keys are managed by administrators within the LinkSquares application and are tied to a specific user account and company.

Create a LinkSquares API Key​

LinkSquares administrators can generate API keys from within the application settings. Best practice is to use a dedicated service account rather than a personal user account for API integrations (for example, linksquares_api@companydomain.com). The service account must be configured as an Analyze or Finalize Administrator, depending on which LinkSquares products your integration will access.

To generate an API key:

  1. Sign in to your LinkSquares account and open the app selector to navigate to Settings.

  2. In the Settings menu, select API Keys.

  3. Click the Generate API Key button to create a new key.

  4. Copy the generated API key immediately and store it in a secure location, such as a password manager. This key grants access to your organization's agreement data and should be kept confidential.

Each API key is associated with a single user email address. If you need to create more than one API key, each key must be tied to a separate email address. To deactivate a compromised key, sign in to LinkSquares, navigate to Settings > API Keys, and disable the key. A replacement key can be generated immediately after.

Additional information is available in the LinkSquares API key management documentation.

Identify Your Base URL​

The default base URL for the LinkSquares API is https://api.linksquares.com. This value is required when configuring the Nexla credential.

Create a LinkSquares Credential​

  • To create a new LinkSquares 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 Authentication​

LinkSquares uses API key authentication. The API key is transmitted in the x-api-key request header with every API call. Nexla handles this automatically once the credential is configured.

  1. Enter the base URL for the LinkSquares API in the Base URL field. For most organizations using the production environment, this value is https://api.linksquares.com.

  2. Enter your LinkSquares API key in the API Key field. This is the key generated in the Prerequisites section above.

    The LinkSquares API enforces a rate limit of 15 requests per second, with a burst allowance of 30 requests. If your integration exceeds this limit, API calls will fail with a "Rate exceeded" error. Nexla manages request pacing automatically, but keep this limit in mind when designing high-volume integrations.

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.