Introduction
API Collections play a crucial role in organizing and managing API endpoints, grouping them according to their access patterns to streamline user interactions with APIs.
For example, a group of Salesforce endpoints configured for use by the Sales team should be organized into an API collection.
"Each automation or process within your system can be transformed into a dedicated endpoint, which gets executed whenever the endpoint is called."
Accessing API Collections
To view or create API Collections, navigate to the API manager section. Here, you will find all the collections available within your workspace.
Create your first API Collection
You can create your first API Endpoint by clicking on “New API Collection” on the top right corner. Follow the prompts to create your API Collection. This may involve entering the following fields:
Name Your Collection: Fill in the Collection Name for your API collection.
For instance, you can enter “UnifyApps task assignment”.Add Description: Include a comprehensive description to define the purpose or functionality of your collection, enhancing clarity for future reference.
Define Path: Determine the URL path that will serve as the access point for your API Collection.
For instance, entering "UnifyApps-task-assignment" results in a URL structure like "https://api-platform-global.ext-alb.qa.unifyapps.com/api/UnifyApps -task-assignment/{endpoint path}".Specify Version: Enter the Version you want to give to your collection.
You can enter something like1.0orv1.
Clicking on the “
Create” button will create the API collection, where you can manage the API Endpoint.
Export API Collection
To share or save the specifications of your API Collection, use the "export collection" at the top right of the collection's page. This tool generates a YAML file containing all endpoint details, making it convenient for sharing.
