Build a Simple Custom API¶
For information on the configuration of a specific type of API, see these resources:
Before creating a Custom API, you must be a member of a Harmony organization with a subscription to API Manager, and you must have the appropriate organization permissions and environment access levels as described in Harmony Permissions and Access.
For information on getting started with API Manager, see API Manager Get Started.
Building an API with API Manager¶
Follow these steps to build a Custom API with API Manager:
Step 1: Creating and Deploying the Operation¶
In this Cloud Studio example, the deployed operation queries a database and processes the data into a CSV output:
- Cloud Studio
- Design Studio
Step 2: Configuring the API¶
Once the Cloud Studio or Design Studio operation has been deployed, navigate to the My APIs page in API Manager and click New API:
On clicking New API, the API Settings configuration screen opens. Populate each field with these settings:
Once the above fields have been populated, click Next.
Since a Custom API is being created, Custom API has been selected as the Service Type. The Cloud Studio operation from Step 1: Creating and Deploying the Operation is assigned to the GET API service:
Once the above fields have been populated and the operation has been assigned, click Save and then click Next.
The operation used for the purpose of this guide has an API Response activity configured as the target of the operation (see Step 1: Creating and Deploying the Operation). As a result, the Response Type is set to Final Target.
On the next screen, user roles and an appropriate security profile(s) are assigned to the Custom API:
For more information on security profiles, see these resources:
On clicking Next, you will arrive at the Summary and Confirmation page:
On clicking Save and Publish, a dialog indicates the API is live:
Click Copy URL. The copied URL will be used in Step 3: Testing the API.
Step 3: Testing the API¶
To test the API, paste the API URL from Step 2: Configuring the API into a web browser:
Once authenticated, the Cloud Studio operation from Step 1: Creating and Deploying the Operation is triggered and responds with a CSV output of Example Company's customer list:
Once the API is live, you can manage the API by generating API documentation on the Portal Manager page, viewing the logs on the API Logs page, or reviewing the consumption and performance metrics for the API on the Analytics page.
For additional information on API Manager, see these resources: