Quickwork
Search…
Quickwork
Table of contents
What is Quickwork
Getting started
Terminologies
Understanding the Quickwork platform
Understanding the Journey Configuration Manager
Folders
Triggers
Actions
Connection
Creating your first journey
Data masking
Clone, comment, and delete
History, connections, versions, and settings
Customized Transaction Table
Sharing and moving a journey
Account settings
If Condition
If Condition using OR operator
If Else Condition
Foreach Loop
Try Catch
Stop Journey
Scheduler by Quickwork
Logger
Callable Journey
API Management
API Management Terminologies
A journey for API Management implementation
Creating an API
Databases
Constants
Team
Audit Logs
Quickwork Embedded - Getting Started
Reverse SSH Tunnel
Powered By GitBook
API Management
Convert your workflows into an API endpoint using API Management by Quickwork. The workflows execute simply by calling the APIs at the client side as per the limits and quota-usage defined.
API Management allows you to create API collections and endpoints for callable journeys. Using these collections and endpoints, you can create API calls that execute the journeys in just one click. The complete process of building, deploying, securing, managing APIs that connect applications and data across an enterprise and cloud are imbibed in the API Management feature.
To use API Management, it is essential to know its terminologies before rushing into its usage and implementation. Once you are aware of the terms, proceed with the following steps:
  1. 1.
    Build a journey with Callable Journey - New call as a trigger and Return response as the end step. The journey must be in the execution state.
  2. 2.
    Create a Path prefix if you are building an API for the first time.
  3. 3.
    Create a new API Collection to store the endpoints created.
  4. 4.
    Create an endpoint for the Callable Journey. Make a note of the API URL.
  5. 5.
    Create a Client and its access profile to get the API key for the API URL. API Key is mandatory to execute the API URL as it authorizes the call before initiating the journey execution.
  6. 6.
    Test the API URL on any API development platform such as Swagger, Postman, etc.
Benefits:
  1. 1.
    Executes callable journeys through a single mouse click.
  2. 2.
    Centrally manages all the APIs in one place and quickly shares them with customers, eventually saving time and cost.
  3. 3.
    Generates API calls can be secured with rate limits and domain-specific execution.
Previous
Callable Journey
Next
API Management Terminologies
Last modified 6mo ago
Copy link