Skip to main content

Authorization

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

Leapfin

Prerequisites​

Before creating a Leapfin credential, you need to have a Leapfin account and obtain an API Key from your Leapfin account settings. The API Key is required to authenticate with the Leapfin API.

To obtain your API Key, sign in to your Leapfin account and navigate to your account settings or API settings section. Locate the API Keys or API Settings section where you can view and manage your API keys. You can generate a new API Key or use an existing one. If you're generating a new API Key, you may be asked to provide a name or description for the key to help identify it later. Copy the API Key immediately after generation, as it may not be displayed again for security reasons. Store the API Key securely, as you will need it to configure your Nexla credential.

The API Key is sent in the X-Api-Key header for all API requests to the Leapfin API. The API Key authenticates your account and grants access to your Leapfin data, allowing you to add records of various object types including payments, invoices, credits, and tax records. For detailed information about API key setup, authentication, and available API endpoints, refer to the Leapfin API documentation.

Create a Leapfin Credential​

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

New Credential Overlay – Leapfin

LeapfinCred.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 Authentication​

Leapfin uses API Key authentication for all API requests. The API Key is sent in the X-Api-Key header to authenticate API requests to the Leapfin API.

  1. Enter your Leapfin API Key in the API Key Value field. This is the API Key you obtained from your Leapfin account settings. The API Key is sent in the X-Api-Key header for all API requests to the Leapfin API. The API Key authenticates your account and determines what data and operations you can access based on your account permissions.

    Keep your API Key secure and do not share it publicly. The API Key provides access to your Leapfin account data and should be treated as sensitive information. If your API Key is compromised, you should immediately regenerate it in your Leapfin account settings. Your Leapfin API Key can be found in your Leapfin account settings (API Keys or API Settings section) where you manage API keys. The API Key is sent in the X-Api-Key header for all API requests to the Leapfin API. The API Key does not expire automatically, but you can regenerate it at any time if needed. For detailed information about obtaining and managing API keys, API authentication, and available endpoints, see the Leapfin 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.