The API manager feature helps configure the external API's for consumption in the entire application. The API manager feature allows users to create new APIs with banterone and assign integration methods.
To configure an API
- Login to banterone
- Click on Developer Options
- Click on ‘API Manager’ from backend menu
- Click on ‘Add Configure API’ button
- Enter ‘Name’ and ‘Description’ for the API configuration. Click the toggle button to activate the configuration immediately.
- Update the API URL
- Select the API ‘Method’ from the drop down menu. The currently available methods are - GET, POST, PUT, PATCH, DELETE, POST FORMDATA, URL ENCODED
- In this example we will be using the the ‘Post’ method
- Users can add ‘Authorization’, ‘Request’, ‘Response’, ‘Final Output’ to the API configuration with JSON. To begin click on the ‘Add’ button in the respective tab
Authorization carries information for the Request and Response Body. Request Authorization.
They give access to execute REST APIs, like giving permissions, to access the information.
It is also expected in the form of JSON only, the same as source parameters.
- In the Pop up enter the name, choose the data structure(String, Object, Array) and click on the ‘Required’ checkbox to make it mandatory. Click on the add button
- Click on the ‘Save’ button on pop up and system will display the JSON query
- The same process can be used to add request, response and final output
- Request - Input parameter required for an API.
- Response- The data is used to store the response of the API.
- Final Output - Used for fetching specific records based on conditions.
- After adding the necessary queries, click on ‘Save’.
- After saving the configuration, the system will redirect to the API Manager screen and display the newly added configuration in the list
Additional notes -
- In the text box, we must enter the API and the method that corresponds to it. The request parameters should be in JSON format, and the output should be string/object-based.
- Headers required for that API are known as ‘AuthTypes’.
- The Final Output tab is used to retrieve data from the provided API.
- Internal and external APIs can both have URLs.