Configuring OpenAPI Accounts

Overview

You can create OpenAPI accounts to connect to data sources that you want to use in your Pipelines. 

Snap-Account Compatibility

Snaps in the OpenAPI Snap Pack work with different accounts and protocols per the following table.

Configuring OpenAPI Accounts

You can configure your OpenAPI accounts in SnapLogic using either the Designer or Manager.

Using SnapLogic Designer

Drag an OpenAPI Snap to the Canvas and click the Snap to open its settings. Click the Account tab. You can now either use an existing account or create a new one.

Selecting an existing account

SnapLogic organizes and displays all accounts to which you have access, sorting them by account type and location. To select an existing account:

  1. Click the  icon to view the accounts to which you have access and select the account that you want to use. 

  2. Click .

Creating an account

  1. Click Add Account in the Account Reference dialog.

  2. Select the Location in which you want to create the account, select the account type, and click ContinueThe Add Account dialog associated with the account type appears.


  3. Enter the required account details. For detailed guidance on how to provide information associated with each account type, use the following links:

    Enter additional information on this account in the Notes field of the Info tab. This will help you–and other users–understand the purpose of the account, especially if there are multiple accounts of the same type.

  4. Click Validate to verify the account, if the account type supports validation.

  5. Click Apply to complete configuring the OpenAPI account.

Using SnapLogic Manager

Use Manager to create accounts without associating them immediately with Pipelines.

Accounts in SnapLogic are associated with projects. You can use accounts created in other projects only if you have at least Read access to them.

  1. In the left pane, browse to the project in which you want to create the account and click CreateAccount OpenAPI, followed by the appropriate account type.

    The Create Account dialog associated with the selected account type appears. 

  2. Repeat the steps numbered 3 through 5 in the previous section.

Avoid updating account credentials while Pipelines using that account are executing. This may lead to unexpected results, including locking your account.

Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main23721 StableUpdated and certified against the current SnapLogic Platform release.

August 2023

main22460

 

Stable

Updated and certified against the current SnapLogic Platform release.

May 2023main21015 StableUpgraded with the latest SnapLogic Platform release.
February 2023

432patches20357

 Latest

The OpenAPI Snaps now support reference components with . in the name of the component.

February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
November 2022431patches19012 LatestPagination in the OpenAPI Snap was fixed for any OpenAPI GET operation with limit and offset values in query parameters.
November 2022main18944 StableUpgraded with the latest SnapLogic Platform release.
August 2022main17386 Stable

The OpenAPI Snap supports external files referenced in the OpenAPI specification field and includes the following new fields:

  • The Pass through checkbox allows you to pass input data to the output under original key.

  • Trust all certificates checkbox that allows you to use self-signed certificates.

  • Enable URL Encoding checkbox that allows automatic URL encoding of the request path.

4.29 Patch429patches16939 Latest
  • Enhanced the OpenAPI Snap with the following:

    • Pass through checkbox that allows you to pass input data to the output under Original key.

    • Trust all certificates checkbox that allows you to use self-signed certificates.

    • Enable URL Encoding checkbox that allows automatic URL encoding of the request path.

    • Support for external files referenced in the OpenAPI specification field.

4.29main15993 Stable
  • Enhanced the Base URL field in the OpenAPI Snap to support suggestions associated with OpenAPI Specifications.

  • Added Dynamic OAuth2 account that enables OAuth authentication for OpenAPI Snap.

4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12989StableFixed an issue in the OpenAPI OAuth2 account that caused a new feature, OAuth Password Grant Type to be excluded from the GA version. The latest deployed build includes this feature.

4.27

main12833

 

Stable

Enhanced OpenAPI OAuth2 accounts with a new option password for Grant Type to obtain an access token through user credentials. On selecting password, the Snap populates the Username and Password fields to enter the credentials.
4.26main11181 
StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10417 Latest

Enhanced the OpenAPI Snap by adding the following two settings:

  • HTTP Headers
  • Query Parameters
4.25 Patch425patches9684 Latest

Adds Send Client Credentials as Basic Auth Header checkbox in the Create Account settings. You can select this checkbox when you want to send the client information as a header to the OAuth endpoint.

4.25main9554 StableNo updates made.
4.24main8556 Stable

No updates made.

4.23-Patches

423patches7812

 
  • Stable
  • Latest

Introduces the OpenAPI Snap Pack to enable you to connect to your OpenAPI endpoints. This Snap Pack supports OpenAPI Specification versions 2.0 and 3.0.


See Also