In this article

Overview

The API Catalog offers Developer Portal users access to the SnapLogic APIs developed in your Org without needing SnapLogic credentials. Developer Portal users can explore APIs and, depending on policies and publication settings, try them. A subscription service allows users to create accounts. Developer Portal users can subscribe to APIs by creating Applications.

Audience

The article is intended for users of a SnapLogic Org Developer Portal and the API developers who publish their APIs and manage them through the Org. Org admins are a secondary audience.

API Catalog

The API Catalog is divided into sections. Click to open the navigation menu.

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

Open

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

• Applications: Displays all Applications.

• Catalog: Displays all APIs.

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

Open

Search for APIs

1. To search for APIs, click to 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.

Your search string will be compared with the following API attributes:

• API Name

• Version

• Created By

• Description

• Tags

Category Selection

You can logically group, filter the selection, and classify APIs by category to more easily navigate the APIs. This increases the productivity targeting a specific service.

• Select a filter and category to classify a service in Developer Portal > Catalog Tab.

   

• After you select the filter and category, you can view the selection with the number of APIs in the selection as a header:

View APIs while you browse the API Documentation

Search results that match with the filter and category in the side pane of the API documentation. When you do this, you enable easy selection of any API and you can view its documentation.

1. Either select the filter and category of the required APIs or enter the API name in the Search Bar of the Developer Portal:

    

2. From the selected filter and category, you can view and select the APIs while you browse through the API document:

Explore an API

You can view the details of any API by clicking the API card. 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 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 to close the API documentation.

Generate Specification

1. Click 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:

• Version: The version of the API.

• Updated: The last time the API version was updated.

• Created by: The creator of the API.

• Description: A description of the API functionality.

• Tags: Metadata labels of the API used to categorize the API contents.

• Other Versions: Other versions of the API, which can be accessed through the version link.

• Contact: The contact information (email and Slack) of the administrator of the API.

• Categories: The API Catalog categories under which the API falls.

• Base URL: The endpoint through which you can invoke the API.

  • The Base URL for OAS 3.0 is displayed as a Server properties settings.

  • The Base URL for OAS 2.0 is displayed as a text link at bottom of the API meta-data section.

• OAS Version: The Open API Specification version that the API was created with.

• Additional details:

  • Documentation: (Specification) The API owner can include a documentation reference in the Swagger editor, which appears as a web link.

  • Terms of Service: (Specification) The API owner can include a link to the terms of service in the Swagger editor, which appears as a web link.

  • License: (Specification) The API owner can include a link to the API license in the Swagger editor, which appears as a web link.

• If the API owner who published the API includes a documentation reference in the Swagger editor, the description appears here as a web link.

You can also view the various HTTP methods and endpoints of the API.

To subscribe to the API, click the Subscribe button, then select or create the application to which you want to add the subscription.

To return to the API catalog, click Cancel.

Authenticate to Use an 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.

Basic Authentication Support for the Proxy

Adding Basic Authentication support to the outbound flow when connecting to a backend service through the API proxy is important to enhance the security and flexibility of outbound connection in the SnapLogic APIM solution. This authentication is executed on the JCC level, and the other policies applied are executed after the execution of Basic Authentication.

1. Add the Basic Authentication security schema to the API specification.

2. Authorize the Basic Authentication you added with login credentials to your API specification..

3. Click the Authorize button:

    

4. Enter the login credentials to authenticate:

5. Click the Authorize button.

View and Try Out an API

You can try out APIs in the Developer Portal while viewing the API’s documentation in the Developer Portal.

Prerequisites

• The API must include a CORS Restriction policy. If the Developer Portal is set up to allow the Try It Out feature for all APIs using the default CORS Restriction policy, the policy is not required at the API level.

• The API must be published.

• You must be authenticated to use the API.

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.