Getting started using integratedFlow API [Information]

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

These are the sections detailed in this article:

• How to get the required API credentials to be able to use the API.
  
• How to use Swagger documentation to learn and test the available API methods.
• How to use Swagger for testing the API calls

HOW TO GET THE REQUIRED API CREDENTIALS

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).

HOW TO USE SWAGGER DOCUMENTATION

You can review the Swagger documentation at https://dev-webhooks.techdinamics.com/integratedflow/swagger.

NOTE: We suggest you bookmark this link for frequent consultation.

integratedFlow's API methods are categorized in Swagger as follows:

• 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

You can refer to How to Use Swagger Documentation [Information] to learn more about using Swagger for reference and testing Techdinamics' APIs.

HOW TO USE SWAGGER FOR TESTING

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