Developers / API v3.0 / Addons (addon)

Addons (addon)

Addons are created first, then typically used within addon groups and/or referenced by items as part of addon configuration.

Auth

  • All addon endpoints require authorization:
    • Authorization: Bearer {{oauth_access_token}}, or
    • mobstep-customer-token: {{customer_token}}

Base URL

  • {{base_path}}{{api_v3_path}}/addon

Notes

  • Friendly entity names are supported in URLs (example: /addon).
  • Legacy internal names (example: /apps_addon) are still accepted.
GET

GET Addons (Auth required)

URL
https://mobstep.com/api/v3.0/addon?fields=id,uuid,application_id,name,price,sku,image,has_components,components,langcode,created,changed
Fields
Name Description
id -
uuid -
application_id -
name -
price -
sku -
image -
has_components -
components -
langcode -
created -
changed -
Headers
Name Value Description
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -
POST

POST Addons: Create (Auth required)

URL
https://mobstep.com/api/v3.0/addon
Headers
Name Value Description
Content-Type application/json -
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -
Body
{
  "name": "Ketchup",
  "application_id": {{application_id}},
  "price": 0.0
}
DELETE

DELETE Addons (Auth required)

URL
https://mobstep.com/api/v3.0/addon/{{api_entity_id}}
Headers
Name Value Description
Authorization Bearer {{oauth_access_token}} -
mobstep-customer-token {{customer_token}} -