Getting started using integratedFlow API [Information]

When interacting with integratedFlow via API there are tools, documentation and good practices that will help you do it in the easiest way possible.

These are the elements detailed in this article:

• Swagger documentation to access API methods
• Receive Credentials from Techdinamics
• Test API calls

Follow the guide and bookmark the documentation as you find it convenient.

SWAGGER DOCUMENTATION

The Swagger documentation details the methods, parameters and values you need to interact with integratedFlow. 

Access and bookmark the following link: https://dev-webhooks.techdinamics.com/integratedflow/swagger/index.html#/

As you become familiar with the integratedFlow API, you will have to consult it frequently.

The documentation is divided in the following sections:

• Authentication: Allows to validate your Credential's status (active, unauthorized or not found)

• IntegratedFlow: Details Post, Get and Put methods to

  • Post method: AddOutboundRecord allows to send information and documents to the Techdinamics Process Queue; this method is the one you will interact the most with, since it's the way to push information for integratedFlow to process

  • Get methods: These allow to retrieve document counts, partner codes, and listing different sets of information

  • Put methods: SetInboundRecordStatus allows to update inbound records statuses

• Models: Details the available objects

For each method, you will find:

A) Method definition and description

B) Parameters that can be used for the function with their respective types and descriptions; some methods have parameters that feature Example and Model modes, detailed as follows:

• Example value: Displays an example of how the parameters should be completed
• Model: Displays the object contents, parameters, data types, max/min length and values when applicable 

C) Parameters Content Type: Whenever a parameter allows, select the type of content you'll send in your request, for example:

D) Try it out: Enables the quick test mode, opening the fields to be completed and an Execute button to execute the method test with the parameters you provided; do not forget to set the Parameter content type to the right option according to your payload whenever applicable:

RECEIVE CREDENTIALS FROM TECHDINAMICS

To be able to interact with the API, you will need your integratedFlow Username and Password.

Reach your Techdinamics POC(s) requesting the API Username and Password and these will be sent to you via a secure link (1Password).

The Username and Password will be used in the next section in the contest of this article to test your connection.

TEST API CALLS

Once you have familiarized yourself with the API, the next step is to test it.

This section details how to use the Try It Out module to test a few interactions.

Try the AddOutboundRecord method, which is the one you will frequently use to send information for integratedFlow to process

To do so, try the following as indicated:

• Reach the Integrator assigned to your project for the request body 
• Authenticate in Test Mode
• Create and execute the request and review the response
• Set the operation Status to Success

REACH THE INTEGRATOR FOR THE REQUEST BODY 

Based on the requirements provided, your assigned Integrator will provide you with a request body based on your project's particular needs.

The Integrator will most likely provide a JSON file, though it could be different depending on the case.

Once you receive this information, have it at hand for the next stage. 

For you to test, the Integrator might also provide a document detailing the payload fields, type, usage and valid values.

AUTHENTICATE IN TEST MODE

Before interacting with the API to post your request, verify your Credentials are ready to be used.

To do so:

1) Press Authorize to begin the Swagger authentication process

2) Enter your Swagger Username and Password as provided by the Integrator

3) Press Authorize

NOTE: This particular step is provided for testing purposes. To authenticate in production mode, the basic authentication, where you'll need to use your Credentials, has to be completed as a part of the method header.

CREATE AND EXECUTE THE REQUEST

Use the Try It Out section with the payload provided by the Integrator. You will also receive additional instructions for the parameters, but note to:

1) Complete the Parameters accordingly

2) Select the Parameter Content Type according to the type of requestBody you will use

3) Press Execute to send the request

4) Review the response result

NOTE: Typically the content of the response will be in Base64 format, so you'll need a Base64 decoding tool to read it in plain text format.

SET THE OPERATION STATUS TO SUCCESS

Once you receive a record, to check its status, you need to mark it as read so that it won’t be

return in your next call. To do this, you need to set the record status to Success by using the

method SetInboundRecordStatus.

To do so, you will have to:

1) Select the method and press Try It Out

2) Set the parameters properly where:

• QueueRecordID: Is the ID of the Queue where your operation executed
• Status: Set as 1, considering that:
  • 0 = New
  • 1 = Success
  • 2 = Failure
  • 3 = Hold
  • 4 = NoProcessing

3) Press Execute to send the request

4) Review the response result