27 Jun
Introduction
This tutorial will guide you through the process of importing the CloudTools OpenAPI specification into Workato. We will use the OpenAPI specification file available at Apptigent CloudTools for Salesforce Sales Cloud.
Prerequisites
- Access to Workato with privileges to create connections.
- OpenAPI specification file for CloudTools.
Steps to Import OpenAPI Specification
1. Install the OpenAPI Connector
- Log in to your Workato account.
- Navigate to the Community Library.
- Search for the OpenAPI connector and click Install connector.
- Click Release latest version to complete the installation.
2. Configure the Connection in Workato
Step 2.1: Provide the OpenAPI Document
- Navigate to Tools > Connector SDK.
- Click the OpenAPI tile.
- Choose the source of the OpenAPI document:
- Document URL: If the file is publicly accessible, select this option and paste the URL.
- Download content: If the file is not publicly accessible, copy and paste the document content directly.
Step 2.2: Define the Authentication Settings
- Select the authentication method from the Authentication Method menu (e.g., Header, OAuth 2.0).
- If you choose the OAuth 2.0 option, be sure to use the OAuth version of the CloudTools for Salesforce connector. This specification is pre-configured for the Client Credential grant flow.
- Provide necessary authentication details from the specification.
- If you choose to use Header authentication with an API Key, the header key is “X-Apptigent-Id” and the value can be found in the License Key field of the CloudTools configuration page in Salesforce (search for “CloudTools” in the App Launcher).
Step 2.3: Define Server and Testing URLs
- Enter the Server URL which is the base URL for the API (e.g.,
https://api.example.com). - Enter the Test Request URL, a relative path of an API endpoint for testing the connection (e.g.,
/user/profile).
Step 2.4: Customize the Interface
- Customize the user interface elements generated from the OpenAPI document:
- Object names
- Field names and hints
- Links to external documentation
- API operation grouping
3. Test the Connection
- After configuring the connection, click Connect to test and save the connection.
- Ensure the connection is successful by verifying the response from the test endpoint.
Conclusion
By following these steps, you have successfully imported the CloudTools OpenAPI specification into Workato and configured it. This integration enables you to automate processes using CloudTools capabilities within Workato.
For more detailed information, refer to the official Workato OpenAPI Connector documentation and the Guide to Setting Up the OpenAPI Connector.
