Versions Compared

Old Version 1

changes.mady.by.user Mandy Du

Saved on

compared with

New Version Current

changes.mady.by.user Danica Chen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Public Application Programming Interface (API) function is an interface that allows sharing your datasets and widgets with your clients. In the Public API section of the MSPbots app, you can create, share, and delete your own API key. Once you have made and shared your public API, your clients can access the datasets and widgets assigned to that key.

What's on this page: 

Table of Contents
stylenone

How to access the Public API section

...

To access the Public API section, log in to MSPbots and navigate to Settings > Public API. 

Public APIImage Modified

How to add, copy, and remove an API key

...

  1. Create an API key: 

    1. Go to the Public API tab and click the Add New Key button. 

    2. Input a Name, select Custom for Type, and provide a short Description for your API.

      add new keyImage Modified 

    3. Click Save.
       

  2. Copy the API Key

    1. Select the API you created in Step 1 from the APIKey dropdown. 
      select APIImage Modified

    2. Click the copy icon to copy the API. Send this to your clients for access to your datasets and widgets. 
      copy api keyImage Modified

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. 

remove keyImage Modified

Connecting your data to an API

...

Binding a dataset to the API key

  1. Go to the Public API tab, click Datasets, and hit the Add button. 
    add datasetImage Modified
  2. On the Add Dataset window, select the dataset or datasets that should be accessible with the API key.
     select datasetImage Modified
  3. 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. 
    add select datasetImage Modified
  4. Click Add Selected once you confirm the list is correct. 
  5. Then you can see the selected dataset in the dataset list.

Image Added

Binding a widget to the API key

  1. Go to the Public API tab, click Widget, and hit the Add button. 
    add widgetImage Modified
  2. On the Add Widget window, select the widget or widgets that should be accessible with the API key.
     select widgetsImage Modified
  3. 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. 
    add select widgetImage Modified
  4. Click Add Selected once you confirm the list is correct. 
  5. Then you will see the selected widget in the widget list.

Image Added

Stop connecting your data to the API

Unbinding your data 

...

To disconnect and unbind data to the API

...

  1. click the Delete icon for the datasets and widgets. 
    Image Modified
  2. Click 

...

  1. Confirm to finish the deletion. 
    confirm deletionImage Modified

Enable Public API Switch 

...

The Enable Public API

...

feature is the global switch that controls the availability of the Public API feature.

...

To activate, switch the Enable Public API toggle ON.  If disabled, the API Keys and all connected data will

...

be inaccessible. 

enable public apiImage Modified

Summary

...

  • Public API provides an HTTP-based API that follows the principles of REST.
  • The HTTP rules allow the use of simple HTTP clients like cURL.
  • The URLs are resource-oriented, the request format is form-encoded, and the responses are JSON.
  • All operations are read-only.

Resources

...

Public API follows the REST model of exposing resources as URLs. The unified domain name of all interfaces is:

https://api.mspbots.ai/

Request, Response, Sample Request

...

REQUEST

Depending on the type of operation, the endpoints use one of two HTTP methods: POST, GET


RESPONSE

The response is in JSON format.


SAMPLE REQUEST

GET REQUEST (Dataset)

curl https://api.mspbots.ai/api/dataset/{resourceId} -H 'apikey: {apiKey}' -X GET

REQUEST

...


Image Added

RESPONSE

Image Modified

...


GET REQUEST (Widget)

curl https://api.mspbots.ai/api/widget/{resourceId} -H 'apikey: {apiKey}' -X GET

REQUEST

...

Image Added

RESPONSE

Image Modified

...

Supported query criteria

(Please Note: Currently, widgets that include measure or calculate layers are not supported.)

sample URL with conditions:

dataset: https://api.mspbots.ai/api/dataset/{resourceId}1?current=1&size=2&project_name=back

widget: https://api.mspbots.ai/api/widget/{resourceId}?current=1&size=10&Real Name=n&Update Date=2021-10-10,2023-03-30,2023-04-05&Id=,1534956341424005122

Logical OperatorsField Typeexample
TEXTNUMBERBOOLEANDATEDATETIME
Is Empty√√√√√status=
Contains√



name=Tod
Equals
√√

is_default=true
id=654321324612312
Later Than (>=)
√
√√price=12.6,
date=2022-07-01
Earlier Than (<=)
√


price=,56.3
between (>= and <=)
√
√√price=12.6,56.3
date=2022-07-01,2023-02-01
Multiple intervals
(>= and <=) or (>= and <=)
√
√√price=12.6,56.3,103,210
date=2022-07-01,2023-02-01,2023-04-01,2023-05-01
(>= and <=) or (=)
√


price=12.6,56.3,105.1
(>= and <=) or (>=)


√√date=2022-07-01,2023-02-01,2023-04-01

Sample Error Responses 

...

  1. Rate limits
    Image Modified
  2. Invalid apiKey: Error or deleted
    Image Modified
  3. Resource unbound
    Image Modified

...

  1. The resource does not exist
    Image Modified
  2. HTTP 502 error status code, please refer to Receiving HTTP 502 Error Status Code When Fetching Data Requests from Widget Using Public API for resolution.
    Image Added

Related Topics

...

Content by Label
showLabelsfalse
showSpacefalse
excludeCurrenttrue
cqllabel = "public"