N O T I C E
MSPbots WIKI is moving to a new home at support.mspbots.ai to give you the best experience in browsing our Knowledge Base resources and addressing your concerns. Click here for more info!
Page History
...
Table of Contents | ||
---|---|---|
|
How to access the Public API section
...
To access the Public API section, log in to MSPbots and navigate to Settings > Public API.
...
Create an API key:
Go to the Public API tab and click the Add New Key button.
Input a Name, select Custom for Type, and provide a short Description for your API.
Click Save.
Copy the API Key
Select the API you created in Step 1 from the APIKey dropdown.
Click the copy icon to copy the API. Send this to your clients for access to your datasets and widgets.
To remove an API Key, click the Remove This Key button. Removing an API key will draw your client's access to the datasets and widgets you assigned to the key.
Connecting your data to an API
...
Binding a dataset to the API key
- Go to the Public API tab, click Datasets, and hit the Add button.
- On the Add Dataset window, select the dataset or datasets that should be accessible with the API key.
- When done selecting the datasets for binding, click the Selected button to view your selection. You may remove datasets from the list by clicking the X sign corresponding to the dataset for removal.
- Click Add Selected once you confirm the list is correct.
- Then you can see the selected dataset in the dataset list.
Binding a widget to the API key
- Go to the Public API tab, click Widget, and hit the Add button.
- On the Add Widget window, select the widget or widgets that should be accessible with the API key.
- When done selecting the widgets for binding, click the Selected button to view your selection. You may remove widgets from the list by clicking the X sign corresponding to the widget for removal.
- Click Add Selected once you confirm the list is correct.
- Then you will see the selected widget in the widget list.
Stop connecting your data to the API
Unbinding your data
...
To disconnect and unbind data to the API ,
- click the Delete icon for the datasets and widgets.
- Click
...
- Confirm to finish the deletion.
Enable Public API Switch
...
curl https://api.mspbots.ai/api/widget/{resourceId} -H 'apikey: {apiKey}' -X GET
REQUEST
RESPONSE
Sample Error
...
Responses
...
- Rate limits
- Invalid apiKey: Error or deleted
- Resource unbound
- The resource does not exist
Overview
Content Tools