API management terminologies

This section explains the essential terms of API management important when creating, managing API endpoint, and client access.

Access profiles

For a client, multiple access profiles may be assigned based on the specific collections you want to grant access to. Each access profile has a unique API key and a set of one or more API collections that it can access. For example, you might assign an admin access profile to grant access to all API collections, while an analytics access profile would only have access to selected API collections.

API collection

An API collection is a set of endpoints that can be managed together. It has a specific path that is defined while creating an endpoint. The API collection path appends to the path prefix, for example, https://apim.quickwork.co/path_prefix/api_collection_path/v1. This structure organizes endpoints under a common path, simplifying management and access.

API endpoint host

The API endpoint host is the base path to which multiple endpoints are appended. The API endpoint host is https://apim.quickwork.co/. It is static in nature and pre-created by Quickwork. You can contact Quickwork’s support team to get a custom domain of your choice as an API endpoint host.

API endpoints

An API endpoint is the path to the action within the resource for which you want to create an API. It is the journey that you want to call upon hitting the endpoint. The API endpoint appends to the path prefix, for example, https://apim.quickwork.co/path_prefix/api_collection_path/v1/api_endpoint. This structure enables precise targeting and activation of specific functionalities within the API.

Client

A client is a user for whom you want to create an API endpoint. The client allows you to create an access profile that includes a set of API collections and an API key for executing endpoints within those collections. A single client can have access to one or more API collections.

Path prefix

A path prefix is a user-defined unique identifier linked to a Quickwork account for API management endpoints. It consists of alphanumeric characters without any spaces. The path prefix is appended to the static API endpoint host, such as https://apim.quickwork.co/<path_prefix>. This prefix is established when setting up API management for the first time and applies to all APIs created within the account. Since the path prefix cannot be changed once set, it should be selected carefully.


📚 Additional resources

API management overview
Building a callable journey for API management
Creating and testing API endpoints
Creating and managing client access
Testing and sharing the API
Sample use case on API management: HR operations
Securing API access with rate limits and quotas