API - FILE IFlow
Steps :
Token step
Get Api - fetches data
File create - creates file
File upload - uploads data
The Steps involved can vary if we implement Global Variable.
Process:
• Delivers a scheduled integration portal-based solution that can be automated to flow data from one system to another ftp/sftp System.
• Get the data from GET API and place the data in the required FTP/SFTP.
• Simplify maintenance and minimize coding with seamless integration into delivery.
Token step
Step Type: REST adapter
Sub Type: POST|application/xml
API URL: https://api.bizom.in/oauth/directLogin/xml
Sample Request:
<User>
<username>ecom_apiadmin</username>
<password>Pir@m@|</password>
</User>
Retrieve Data using Get API
With the Get API, we retrieve the data using page filters.
In the response formatter, the structure and format of the retrieved data is stored in an object with the help of Nashorn template.
Pagination filters to fetch data from API:
Start & end sequence
date / time filter
Batch count & size
Step Type: REST adapter
Sub Type: POST|application/xml
File Create Step
It is a SFTP/FTP step and here a file is created on the server.
In this step, settings are given to detail on the file format, delimiter, extension and structure.
Step Type: File Create Adapter
Sub Type: SFTP
File Upload Step
The generated file in the 3rd step is uploaded to sftp server at this time.
As in the third step, here also step settings are added to detailing.
Step Type: File Upload Adapter
Sub Type: SFTP
File path in OIP:
Parameters:
user name
Password
Host name/IP address
Port
Main folder path
New folder path
Processed folder path
inProgress folder path
Separated by delimiter.
Example:
PiramalGroup|LpDGNCkP0o|integrationdata.bizom.in|22|/integrationftp.bizom.in/PiramalGroup/bizom/Trishul/prod/PrimaryOrder_BizomToSAP|new|processed|inProgress
Step Settings:
Notes:
The Step Type and Type are based on the adapter used for the step.
The Logging enabled is to show the log for the step in step history.
In the 3rd and 4th step, there is no request and response involved since we are only creating a file and uploading the data into it.
Last updated