EmbedThis

Appearance

Product ​

Manage Products.

Create ​

Create a product definition

Endpoint

POST /product/create

Authorized User Role

admin

Request Body

Field | Type | Role | Notes

  • | - | - | - advance | boolean | | agent | string | | align | boolean | | current | object | support | description | string | | end | date | | interest | array | | meter | boolean | | name | string | | Must be a unique name. notify | array | | pending | boolean | | period | string | | scope | string | | start | date | | type | string | | units | number | | url | string | |

Response

Field | Type

  • | - accountId | string description | string id | string name | string planId | string suspended | boolean url | string

Get ​

Get a product definition by ID

Endpoint

POST /product/get

Authorized User Role

user

Request Body

Field | Type | Required

  • | - | - id | string | yes

Response

Field | Type

  • | - accountId | string description | string id | string name | string planId | string suspended | boolean url | string

Find ​

Endpoint

POST /product/find

Authorized User Role

user

Request Body

Field | Type | Role

  • | - | - accountId | string | support

Query String Options

Field | Type

  • | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean

Response

Paged response.

Field | Type | Notes

  • | - | - data | array | An array of metrics each containing an array of metric with the following properties. next | string | Paged cursor to use for the next page of items. prev | string | Pages cursor to use for the previous page of items.

Product

An array of Product items.

Field | Type

  • | - accountId | string description | string id | string name | string planId | string suspended | boolean url | string

Init ​

Endpoint

POST /product/init

Authorized User Role

user

Request Body

A object.

Response

Field | Type

  • | - accountId | string description | string id | string name | string planId | string suspended | boolean url | string

Remove ​

Remove a product definition

Endpoint

POST /product/remove

Authorized User Role

admin

Request Body

Field | Type

  • | - id | string

Update ​

Update a product definition

Endpoint

POST /product/update

Authorized User Role

admin

Request Body

Field | Type | Role | Notes

  • | - | - | - advance | boolean | | align | boolean | | agent | string | | Set to Ioto, GoAhead or Appweb. current | object | support | description | string | | id | string | | end | date | | interest | array | | meter | boolean | | Set to true to use automatic volume metering. name | string | | notify | array | | pending | boolean | | period | string | | planId | string | | scope | string | | start | date | | type | string | | units | number | | url | string | |

Response

Field | Type

  • | - accountId | string description | string id | string name | string planId | string suspended | boolean url | string

Download ​

Download software

Endpoint

POST /product/download

Authorized User Role

user

Request Body

Field | Type | Required

  • | - | - image | string | yes planId | string |

Response

The download URL for the requested image.