Skip to main content

Authorization

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

SplashThat

Prerequisites​

Before creating a SplashThat credential, you need to obtain your Client ID, Client Secret, Username, and Password from your SplashThat account. SplashThat uses OAuth2 2-legged authentication (password grant type) for all API requests, with credentials sent in the request body to obtain an access token.

To obtain your SplashThat credentials, follow these steps:

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

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

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

  4. If you don't have OAuth credentials yet, look for the option to create or register an OAuth application.

  5. Click Create OAuth App or Register Application to create a new OAuth application.

  6. Configure your OAuth application settings:

    • Enter a name for the application (e.g., "Nexla Integration")
    • Review and select the permissions or scopes for the application (typically user scope)
    • Note the Client ID and Client Secret that are generated

  7. Copy the Client ID and Client Secret immediately after they are generated, as the Client Secret may not be accessible again after you navigate away from the page.

  8. Your Username and Password are your SplashThat account credentials that you use to sign in to your SplashThat account.

  9. Store all credentials securely, as you will need them to configure your Nexla credential. The Client ID, Client Secret, Username, and Password are sensitive information and should be kept confidential.

The OAuth2 credentials are used to obtain an access token via the password grant type. The Client ID and Client Secret are sent along with your Username and Password in the OAuth token request to obtain an access token. The access token is then sent in the Authorization: Bearer {token} header for all API requests to the SplashThat API. The token authenticates your requests and grants access to SplashThat resources based on your account permissions. If your credentials are compromised, you should immediately revoke them in your SplashThat account settings and generate new ones. For detailed information about OAuth2 authentication, API access, and available endpoints, refer to the SplashThat API documentation.

Create a SplashThat Credential​

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

New Credential Overlay – SplashThat

SplashThatCred.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 2-Legged Authentication​

SplashThat uses OAuth2 2-legged authentication with password grant type for all API requests. The Client ID, Client Secret, Username, and Password are used to obtain an access token, which is then sent in the Authorization header with the Bearer prefix.

  1. Enter your SplashThat Client ID in the Client ID field. This is the Client ID you obtained from your SplashThat account settings (Settings > API or Account > API Settings) when creating your OAuth application. The Client ID is used along with the Client Secret, Username, and Password to obtain an access token for API requests.

  2. Enter your SplashThat Client Secret in the Client Secret field. This is the Client Secret you obtained from your SplashThat account settings when creating your OAuth application. The Client Secret is used along with the Client ID, Username, and Password to obtain an access token for API requests. The Client Secret is sensitive information and must be kept confidential.

  3. Enter your SplashThat Username in the Username field. This is the username you use to sign in to your SplashThat account. The Username is used along with the Password, Client ID, and Client Secret to obtain an access token for API requests.

  4. Enter your SplashThat Password in the Password field. This is the password you use to sign in to your SplashThat account. The Password is used along with the Username, Client ID, and Client Secret to obtain an access token for API requests. The Password is sensitive information and must be kept confidential.

    Your SplashThat OAuth credentials can be found in your SplashThat account settings under Settings > API or Account > API Settings. The Client ID and Client Secret are generated when you create an OAuth application. The Username and Password are your SplashThat account credentials.

    These credentials are used together to obtain an access token via the OAuth2 password grant type. The access token is then sent in the Authorization: Bearer {token} header for all API requests to the SplashThat API.

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

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