API management overview

Understanding APIs

An Application Programming Interface (API) is a set of protocols and definitions that enables two separate software components to communicate. For instance, a weather application on your smartphone retrieves daily weather data by communicating with the weather bureau’s software system through an API. This interaction involves making an API call to a URL, which includes HTTP request methods such as POST, GET, PUT, PATCH, or DELETE, along with possible headers and a body. The API then responds with the requested data. Another example is the Freegeoip API, which provides geolocation data for an IP address, effectively turning a simple URL request into actionable information.

API management in Quickwork

The API Managementtool in Quickwork works in conjunction with callable journeys, allowing you to convert a function into an API. This setup supports synchronous request-reply patterns, providing a response from the journey within 90 seconds. If no response is received, the request times out, returning a 504 error. API management requires an authentication mechanism such as API Key, OAuth, or Mutual TLS; without this, the API cannot be exposed. Each API request is limited to a 1MB payload. Exceeding this limit results in an "entity too large" error, necessitating a smaller request body. API management also offers rate-limiting, quota management, and IP whitelisting to protect your API on the internet.

Benefits of API management

1. Improved efficiency: Automates and executes callable journeys with a single API call, enhancing productivity.
2. Central management: Provides a centralized interface to manage and share APIs, reducing time and cost.
3. Enhanced security: Employs rate limits and domain restrictions to safeguard API integrity and ensure reliable usage.

Creating & testing an API

1. Configure a Callable Journey with New call as the trigger and Return Response(if required) as the final action. Ensure the journey is active.
2. For first-time users, create a path prefix that forms the base URL for all your APIs.
3. Organize and manage your APIs by creating a new API collection to store the endpoints.
4. Develop and configure an API endpoint linked to the callable journey. Note the URL.
5. Create a client and its access profile to generate an API key to secure and authorize API calls.
6. Utilize tools like Postman to test API functionality and response accuracy.

📚 Additional resources

API terminologies
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