...
| Table of Contents | ||||
|---|---|---|---|---|
|
Browse through the API Catalog
The API Catalog allows you to browse APIs or to search for specific APIs.
Select A View
You can view the APIs that are available in the API Catalog by selecting one of the following two views:
Grid View: (Default view) Each card represents an API and includes details, such as the version, the creator, the date when the API version was last updated, and a short description of the API. The card might also include a Featured pill at the top (if it is a featured API) and several pills for each tag at the bottom (if tags are assigned to the API). To view the entire catalog, click View More. Click View Fewer to reset.
List View: APIs are listed on a scrolling page with columns indicating the version, creator, last time updated, a truncated description which you can expand, and tags.
...
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 three sections. The navigation panel displays three icons, which correspond 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.
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.
...
Search for APIs
To search for APIs, click
to display the entire API catalog
...
.
Enter your search string in the Search field
...
.
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
...
| Anchor | ||||
|---|---|---|---|---|
|
You can view the details of any API by clicking the API tile or its name when in the list view. Clicking the API displays the documentation of that API.
...
To return to the API catalog, click Back to Catalog on the top left corner of the page Cancel.
| Anchor | ||||
|---|---|---|---|---|
|
To authenticate to use an API,
Click the security lock icon to open the Available authorizations dialog.
...
...
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 in into the Value field.
Basic authorization. Enter your SnapLogic account credentials.
...
Click the
Authorize button of the section you filled in.
...
The API must include a CORS Restriction policy. If the Developer Portal is set up to allow the “Try Try It Out” 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,:
Expand one of the panels that show an HTTP method and an API endpoint.
...
Click the Try it out button at the top right of the expanded panel.
Fill in the values in the Parameters section.
Verify the results in the Responses section.