Skip to main content

Authorization

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

VinSolutions

Prerequisites​

Before creating a VinSolutions credential, you need to obtain your Client ID, Client Secret, and API Key from your VinSolutions Developer account. VinSolutions uses OAuth2 client credentials (2-legged) authentication for all API requests, along with an API key sent in the request headers.

To obtain your VinSolutions OAuth credentials and API key, follow these steps:

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

  2. Navigate to the VinSolutions Developer Portal or API settings in your VinSolutions account, typically accessible from the account menu or settings icon.

  3. In the Developer Portal or API settings, navigate to API Keys or OAuth Applications to access your OAuth application and API key management.

  4. If you don't have an OAuth application yet, click Create Application or Register Application to create a new OAuth application.

  5. Configure your OAuth application settings:

    • Enter a name for the application (e.g., "Nexla Integration")
    • Review and accept the VinSolutions API Terms of Service
    • Set the application type to Client Credentials or 2-legged OAuth
    • Set the scope to PublicAPI
    • Click Create or Register to create the application

  6. After the application is created, you will see your Client ID and Client Secret. Copy both values immediately, as the Client Secret may not be accessible again after you navigate away from the page.

  7. In the same Developer Portal or API settings, navigate to API Keys to access your API key management.

  8. If you don't have an API key yet, click Create API Key or Generate API Key to create a new API key.

  9. Configure your API key settings:

    • Enter a name for the API key (e.g., "Nexla Integration")
    • Review the API key permissions or scopes (if applicable)
    • Click Create or Generate to create the API key

  10. Copy the API Key value immediately after it's generated, as it may not be accessible again after you navigate away from the page.

  11. Store all three credentials securely, as you will need them to configure your Nexla credential. The Client Secret and API Key are sensitive information and should be kept confidential.

The Client ID and Client Secret are used in the OAuth2 client credentials flow to obtain access tokens. The API Key is sent in the api_key header for all API requests to the VinSolutions API. These tokens and keys are then used to authenticate your requests. If your credentials are compromised, you should immediately revoke them in your VinSolutions Developer Portal and generate new ones. For detailed information about obtaining OAuth credentials and API keys, API authentication, and available endpoints, refer to the VinSolutions API documentation.

Create a VinSolutions Credential​

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

New Credential Overlay – VinSolutions

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

OAuth2 Client Credentials Authentication​

VinSolutions uses OAuth2 client credentials (2-legged) authentication for all API requests. This method uses your Client ID and Client Secret to obtain access tokens automatically. Additionally, an API Key is required and sent in the request headers.

  1. Enter your Client ID in the Client ID field. This is the OAuth2 client identifier you obtained from your VinSolutions Developer Portal (OAuth Applications). The Client ID is used to identify your application when requesting access tokens.

  2. Enter your Client Secret in the Client Secret field. This is the OAuth2 client secret you obtained from your VinSolutions Developer Portal. The Client Secret is used together with the Client ID to authenticate your application and obtain access tokens. The Client Secret is sensitive information and must be kept confidential.

  3. Enter your API Key in the API Key field. This is the API key you obtained from your VinSolutions Developer Portal (API Keys). The API Key is sent in the api_key header for all API requests to the VinSolutions API. The API Key is sensitive information and must be kept confidential.

    Your VinSolutions OAuth credentials (Client ID, Client Secret) and API Key can be found in your VinSolutions Developer Portal under OAuth Applications and API Keys. The Client Secret and API Key are sensitive information and must be kept confidential.

    If your credentials are compromised, you should immediately revoke them in your VinSolutions Developer Portal and generate new ones. The OAuth credentials and API Key provide access to your VinSolutions account data and should be treated as sensitive information. Keep your credentials secure and do not share them publicly.

    For detailed information about obtaining OAuth credentials and API keys, API authentication, and available endpoints, see the VinSolutions 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.