Developers
This page contains all the information regarding developers section inside botpenguin platform.
Last updated
This page contains all the information regarding developers section inside botpenguin platform.
Last updated
Empower your developers to harness the full potential of your dashboard. In this section you can configure your APIs. You can test and manage the same which you can use to trigger in your chat flows.
Step 1: Go to Home page of BotPenguin.
Step 2: Click on "Developers" section available under more options.
Step 3: Inside "Your APIs" you can see all the APIs previously created by you and can edit or delete the same. You can also search an API using API name.
Step 4: Click on "Add API" to create and add a new API according to your use case.
Step 5: Inside "Configure API" you can add:
API Name
Methods for API request (Get, Post, Put or Delete)
API URL
The steps to be followed from "Step 6" are completely optional.
Step 6: Enter information in the navigation tabs
Parameters -> Enter a key and its value, you can also add more fields for the same. It is used to append variables in the URL. You can map attribute values here.
Headers -> They contain sensitive information about the request and the response. Here also you can map the custom attributes
Body -> Used to send the data with the request. You can also select a custom attribute by using "/" to send in the body. And also you can send a static message by typing it in between " ".
Recommended not to be sent with GET request.
Manage API Response -> When API is hit the response received will be mapped with a custom attribute that can be selected from the drop down. Select a custom attribute for the variable.
Third Party Integrations -> You can click on "Connect" to integrate with third party apps. This will redirect you to their page for further process.
Step 7: After that click on "Test" to test your API Configurations.
Step 8: And click on "Save".
Step 9: In API Logs you will get detailed record of all API requests & responses triggered within the chatflow of the chatbot.
Step 10: In Access Token you can generate your token for using platform's API's which can be sent in API headers inside Auth key.
Step 11: Click on "Regenerate API Token" to have your Access Token regenerated.
Now go to the bot section and select the bot in which you want to setup your API.
Select the flow in which you want to use your API
Add "API" component into your chat flow.
Select the API component and customize it.
You can map a go to next message for: 1. others -> This includes scenarios in which neither success nor fail. Ex: Server Down. 2. 200 -> It is response code which means your API is working good and its a success. 3. 400 -> It is response code which means your API is not working and its a fail case.
You can use your custom attribute which was mapped with the API by typing "/".
Here when response code 200 is recieved. The next message will be sent as "Today's Fact is {{cat_fact}} ". This will contain the data that will be received from the API source.
If everything is correct and you are still unable to move forward, write to us at . We will respond back within 48 business hours.
