This site uses different types of cookies, including analytics and functional cookies (its own and from other sites). To change your cookie settings or find out more, click here. If you continue browsing our website, you accept these cookies.
Quick Guide: API Catalog in Connect
Do you use APIs for your work? Based on the information published online, in 2019 the number of APIs exceeded 22,000 entries. APIs and their endpoints are one of the very popular data sources and are used in Alteryx workflows as well. Information about used APIs is now available in Connect since version 19.4. The information is extracted from workflows’ log and cataloged.
To use the API catalog, you must install Connect version 19.4 as well as Server version 19.4. The reason behind that is the way the APIs are harvested. They are not harvested from the workflows directly but from the log in the job log. It means they are generated from the data logged on the Server. Lineage is automatically created between a workflow and an API endpoint. Thus, it's necessary to run the workflow at least once on the server to get the APIs from it.
API sites are available in Data Sources
Essential Info about API Catalog
To access the list of API endpoints, go to main menu > Data Sources > API sites. API is an asset type under Data Sources.
Note: API sites folder is by default visible only for Administrators group. The permissions can be easily modified by an Administrator. Navigate to see the permissions of the API sites folder by clicking the Action drop-down arrow and select Permissions. A window with a permission table pops up. You can change the permission under the Inherited permission table where you can see the list of all actions. Click in any field to add a user group or individual users to a permission level. For more information see Permissions .
The following information about an API endpoint can be viewed:
You can add a description for an asset, such as asset name, link to the asset page, or link to the API documentation. Note: API documentation is generated automatically.
Action: Message to a resource to perform a certain operation, such as GET, POST, PUT, DELETE.
URIs: Uniform Resource Identifier. Address which identifies a resource.
Parameter/Attribute Values: Options you can pass with the endpoint to influence the response.
Attachment: You can upload more information for the specified API.
All relationships, including data lineage, can be viewed using Nexus. Click to Open nexus, a navigable map that shows a web of connections between assets.
Details of an API endpoint
When to Use API catalog?
As a developer, you can use the API catalog to find the API you need in your workflow. The catalog provides detailed insight into how API endpoints are used in a workflow and give visibility into a workflow’s lineage.
As a user, you can check where - in which workflows - the API endpoint is used. Check Relationships to see the lineage.
Example of the Relationships section of an API endpoint
API catalog is also mentioned in the following articles: New in Connect 19.4 and Release Notes 19.4.