Join this online group to communicate across IBM product users and experts by sharing advice and best practices with peers and staying up to date regarding product enhancements.
Create workflow and use of API keys
Introduction
This article explains about use of API keys while working with workflows.
Pre-requisite
webMethods.io Integration tenant with Admin access.
Audience
This article is intended for readers who are familiar with webMethods.io Integration
What Are API Keys?
API keys are unique alphanumeric strings used to authenticate and authorize access to APIs.
Think of them as digital ID cards for apps or services accessing data or functionality via APIs.
Steps to Create and Use API Keys
API key can be created using IBM SAAS Console, to access IBM SAAS Console subscribe to a trial or a paid product subscription or accept an invitation.
To know more about the IBM SAAS Console refer to https://www.ibm.com/docs/en/saas-console?topic=accounts-getting-started-saas-console
Step 1 : Access Subscriptions
Go to the IBM webMethods Hybrid Integration (IWHI) landing page.
Click Access Management to enter the IBM SaaS Console.
Note : Active subscription indicates its current and available.
Step 2: Navigate to Instances
Each product determines the number of instances that you can provision per subscription.
Click View Subscription Details to see all provisioned instances under your subscription.
Step 3 : Create Service IDs
Administrators can create service ID’s and use the ID to connect to another application through API authentication and authorization.
For creating Service ID Go to the Service IDs tab within an instance.
Choose a role based on user type:
Integration admin: It will have admin users of webMethods.io instance
Integration user: Developer role users of webMethods.io instance
Service admin/Service owner: It will have admin user role of webMethods.io instance
Service user: Developer role users of webMethods.io instance
Note: API keys must be linked to a Service ID.
Step 4 : Create API Keys
In the same section, click the icon next to the Service ID and select Create API Key.
Fill in the key name, description, and expiration date.
Note: ServiceID will be auto filled so those fields will be greyed out.
Copy the key immediately—it won’t be shown again!
Invoke Workflows Using API Keys
Create a Workflow Follow the guide on workflow creation in webMethods.io.
https://community.ibm.com/community/user/viewdocument/tech-bytes-iwhi-creation-of-workf?CommunityKey=82b75916-ed06-4a13-8eb6-0190da9f1bfa&tab=librarydocuments
Use the API Key
Copy the public URL of the REST API.
In any REST client (like Postman or insomnia), add a header: Code
If the header is missing, you’ll get a 401 Unauthorized error.
Note: In MCSP environments, API keys are mandatory since basic authentication is not supported.