Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The API Catalog is divided into sections. Click (blue star) to open the navigation menu.

The navigation panel menu displays icons that correspond shortcuts to these sections, as shown in the following image.

...

  • Home Page: Displays a preview of Applications and APIs.

  • Applications: Displays all Applications.

  • Catalog: Displays all APIs.

Click (blue star) in the top left-side corner to return to the Home page.

Home Page

The Home page displays a selection of your Applications along with APIs that are marked Featured. Click See All to show all of your Applications or all APIs in the Catalog.

...

  1. To search for APIs, click (blue star) to display view the entire API catalog in the Developer Portal.

  2. Enter your search string in the Search field.

  3. Optionally, select the default filters (Featured and Deprecated) for your search, and click Apply. You can further filter the search results by clicking the available categories.

...

You can view the details of any API by clicking the API tilecard. Clicking the API displays the documentation of that API.

...

Subscribe to an API

...

  1. Click Subscribe.

  2. Proceed through the API subscription wizard.

View Documentation

  1. Click (blue star) to open the API definitions and documentation for each REST call.

  2. Click Authorization or the padlock by each REST call to open Authorizations Available dialog. When you subscribe to an API, you receive the bearer token or key to call the API.

  3. Scroll through each REST call to view Parameters and Responses.

  4. Click (blue star) to close the API documentation.

Generate Specification

  1. Click (blue star) to generate a specification for the API.

  2. Choose one of the following formats for your specification download:

    • JSON

    • YAML

  3. Navigate to your local downloads folder to open the specification.

‌API Details

The following details are provided for the API:

...

To authenticate to use an API,

  1. Go to the API Documentation page.

  2. Click the security lock icon to open the Available authorizations dialog.

  3. Depending on the configuration of the API, you can authenticate by filling in one of the following sections in the Available authorizations dialog:

    • applicationSecret (apiKey). If you created an application, edit your application and copy the Client Secret from the Edit Application dialog and paste it into the Value field.

    • Basic authorization. Enter your SnapLogic account credentials.

  4. Click the Authorize button of the section you filled in.

...

To try out the API:

  1. Expand one of the panels that show an HTTP method and an API endpoint.

  2. Click the Try it out button at the top right of the expanded panel.

  3. Fill in the values in the Parameters section.

  4. Verify the results in the Responses section.

...