Invoke External API using Titan Flow

Business Background

Titan Flow provides your business freedom of choice to invoke an external API of preference. The business edge of using external APIs with Titan is that you work with a broader customer base, not just those that utilize Google Drive, Amazon S3, or OneDrive.

Titan Solution

Titan Flow allows an admin to configure the triggers, parameters, and authentication for an external/custom API.

How to Video

Coming soon!

How to Guide

Any API can be triggered, parameters can be sent, and authentication can be done. Get the results back from the API and map the response to different variables on Titan Flow.

Note:

Data can be sent to a service (for instance, SMS), and some data can be received.

  1. Create a new project or open an existing project in Titan Flow.
  2. Click on the + sign. The Add Node screen opens.
+ sign
+ sign
  1. Click the Integrations option.
  2. Click the Custom API option and click the Next button. The Add Node/Custom API screen opens.
Add Node screen
Add Node screen

Step 1 – General Customization

  1. Paste the endpoint (URL) for the API in the Custom URL field.
  2. Select the method from the Method drop-down list. The options are as follows:
    • Get
    • Post
    • Put
    • Path
    • Delete
  3. If necessary, select a file to upload from the drop-down list. This must be a DocGen file.
  4. If necessary, click the Basic authentication checkbox to set the authentication. Currently, only username and password authentication are supported.
Add Node/Custom API screen - step 1
Add Node/Custom API screen – step 1
  1. Click the Next button.

Step 2 – Parameters

  1. If necessary, click on the Add param button to send data to the Custom API.
    • Type a parameter name in the field to add service parameters.
    • Select the Static or Field from the drop-down list.
Add Node/Custom API screen - step 2
Add Node/Custom API screen – step 2
  1. Click the Next button.

Step 3 – Headers

  1. If necessary, click the Add header button to add header parameters.
    • Type a header name in the field to add a service header.
    • Select the Static or Field from the drop-down list.
Add Node/Custom API screen - step 3
Add Node/Custom API screen – step 3
  1. Click the Next button.

Step 4 – API Output Parameters

  1. Get back any responses from the API. Invoke the API and map the response to different variables on Titan Flow. Once you have the response in Titan Flow, you can continue the process using the Titan platform.
Note:

Prerequisite:

You must have added the project variables to Titan Flow to map them afterwards.

  1. Use the drop-down list to select the Plain Result variable. The API result is JSON. All the parameters for the response will be mapped to this variable. You will get the full response from the API and Titan will not do any parsing.
  1. As an alternative, do the Object mapping by clicking the Add param option. Titan will parse the values, and you will only get the value from a specified parameter.
    • Add as many fields as necessary.
    • Add specific parameters and map a field to a value by using the drop-down lists.
Note:

In this example, the following JSON is used:

This image has an empty alt attribute; its file name is image-519.png

The mapping is case sensitive and must be exactly the same as the JSON.

Add Node/Custom API screen - step 4
Add Node/Custom API screen – step 4
  1. Click the Next button.

Step 5 – Give it a name

  1. If necessary, type a tag in the Tag field and click the Insert button.
Custom API added
Custom API added

Custom API is integrated with Titan Flow.  

Hidden Title

Need more help?