Skip to content

API configuration

  APIs are used in backend development that returns JSON objects and can be used to retrieve and Push data.

In API Configuration, user can configure APIs according to the type which is used for

img

There are some points to note when configuring APIs that are

  • If API is used to retrieve data from a table, it should specify the Type as Export, like in the image given below

img

· The user has to give a unique name for the API as APIName in the entry

· SQL query is required to retrieve the data that can take from the specified table.
  Here, the import and export table structure should be the same.

· The table name and insert type are not required for the import type

Here we will get a JSON object as a result.

  • If API is used to push data into a table, it should specify the Type as Import, like in the image given below

img

· The user has to give a unique name for the API as APIName in the entry

· Table name is required to push data into the specified table.
  Here, the import and export table structure should be the same.

· Three types of insert types can be used for importing data.

    Append: Adds to the database incrementally. If the data already exists, it will not 
            replace that data. It will throw an error if data are already present.

    Replace: Adds to the database incrementally. If the data already exists, then it will 
             replace that data.

    Clear All: Clears all the contents in that table and loads the data contained in a flat file 
               or Excel.

· The SQL query is not required for the import type