The API endpoint to access your widgets is located at
http://api.bubobox.com/widgets
To access the details of a widget you need to perform a GET
request to URL below. WIDGET_ID
should be replaced by the ID of the widget to retreive.
http://api.bubobox.com/widgets/WIDGET_ID
You can list all your widgets and filter them.
http://api.bubobox.com/widgets
This endpoint requires you to do a GET
request.
Header | Default | Description |
---|---|---|
Accept-ranges | none | Spreads results over multiple pages, needs to be set to resources |
Parameter | Default | Description |
---|---|---|
offset | 0 | Sets the offset at which results will start. |
limit | 50 | The amount of records that will be returned by the API. |
search | A string that will be searched for in the widget. |
You can create a widget through this endpoint.
http://api.bubobox.com/widgets
This endpoint requires you to do a POST
request.
Parameter | Default | Description |
---|---|---|
name | The name associated with the widget. | |
url | The URL at which the widget will appear. | |
type | The type of widget you wish to create. Can be testimonial, product or job | |
meta | An array of meta-data that will be associated with this widget. |
You can update a widget through this endpoint, where WIDGET_ID
is to be replaced by the widget ID that you wish to alter.
http://api.bubobox.com/widgets/WIDGET_ID
This endpoint requires you to do a PUT
request.
Parameter | Default | Description |
---|---|---|
name | The name associated with the widget. | |
url | The URL at which the widget will appear. | |
type | The type of widget you wish to create. Can be testimonial, product or job | |
meta | An array of meta-data that will be associated with this widget. |
This endpoint allows you to delete a widget with WIDGET_ID
as its id.
This endpoint requires you to do a DELETE
request.
http://api.bubobox.com/widgets/WIDGET_ID
Can't find an answer to your question?
Can't find an answer to your question or problem? Support requests are the most efficient way for us to handle your support inquiries.