# API - FILE IFlow
#### Steps :
1. Token step
2. Get Api - fetches data
3. File create - creates file
4. 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.
1. **Token step**
This is a Bizom API step, to generate a token using username and password credentials. 
Step Type: REST adapter
Sub Type: POST|application/xml
API URL:
#### Sample Request:
\
\ecom\_apiadmin\
\Pir\@m@|\
\
2. **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
API URL: [https://api.bizom.in/salesreturns/getSalemansalesreturn/?access\_token=${configs\['0'\].values\['1'\]\['Token'\]}\&responsetype=json\&fromdate=${lastScheduledStartTime?date} \&todate=${nextRunTime?date}\&startseq=${startSequence}\&endseq=${endSequence}\&fromtime=${lastScheduledStartTime?time}\&totime=${nextRunTime?time}\&is\_primary=1\&groupbytransactions=1](https://api.bizom.in/salesreturns/getSalemansalesreturn/?access_token=$%7Bconfigs\['0'].values\['1']\['Token']%7D\&responsetype=json\&fromdate=$%7BlastScheduledStartTime?date%7D)
3. **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
4. **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:
| Step Setting | Description |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| CSV\_DELIMITER | To configure the Delimiter by which the values in the file are separated. |
| FILE\_NAME\_FOR\_FILE\_UPLOAD | Name with which the file is uploaded in the server |
| FILE\_EXTENSION\_FOR\_FILE\_UPLOAD | Extension with which the file is uploaded in the server |
| DATE\_FORMAT\_FOR\_FILE\_UPLOAD | Date format with which the file is uploaded in the server |
| APPEND\_DATA\_IN\_SINGLE\_FILE | This setting is given when the data of different batch or API to be uploaded to the same file or in different file |
| WINDOWS\_LINE\_DELIMITER | To configure the Windows command line Delimiter by which the values in the file can be separated. |
| UPLOAD\_EMPTY\_FILE | To configure whether to upload an empty file into the server or not |
#### 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.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://oresund-integration-platform.gitbook.io/oresund-integration-platform/about/product-and-developer-guide/sample-description-of-i-flows/api-file-iflow.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.