App builder
9 routes. Paths are relative to https://api.intersink.com/v1.
- GET/app-builder/apps/{id}An app's capabilities, navigation and prices
- PATCH/app-builder/apps/{id}Edit my developer app
- DELETE/app-builder/apps/{id}Archive my developer app
- DELETE/app-builder/apps/{id}/capability-requestTake back my app's capability change that is waiting for review
- GET/app-builder/apps/{id}/capability-versionsMy app's capability versions, newest first (approved, pending review, rejected, withdrawn)
- POST/app-builder/apps/{id}/submitAsk the platform channel to review the app for the Store
- GET/app-builder/businesses/{businessId}/appsMy business's developer apps
- POST/app-builder/businesses/{businessId}/appsCreate an app (private to your channels until its review is approved)
- GET/app-builder/capabilitiesEvery capability an app can bundle (key, label, panel nav, API prefixes)
An app's capabilities, navigation and prices
GET/app-builder/apps/{id}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is of type object.
Edit my developer app
PATCH/app-builder/apps/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| package_name | string | Reverse-DNS package name, unique in the Store (required to create) At least 3 characters, at most 120 characters. Example: "com.example.orders" |
| key | string | Stable key (a-z, 0-9, -). The platform's own apps only; others get one. Example: "orders" |
| name | string | At least 2 characters, at most 80 characters. Example: "Multivendor" |
| description | string | At least 0 characters, at most 500 characters. |
| category | string | At least 0 characters, at most 60 characters. Example: "Commerce" |
| icon | string | At least 0 characters, at most 40 characters. Example: "cart" |
| color | string | Example: "#16A34A" |
| capabilities | string[] | Capability keys (GET /app-builder/capabilities) |
| price_gbp_minor | number | Monthly GBP price in pence; 0 = free Minimum 0. Example: 2499 |
| price_usd_minor | number | Monthly USD price in cents; 0 = free Minimum 0. Example: 2999 |
| homepage_url | string | |
| webhook_url | string | |
| availability | string | The platform's own apps only; ignored for others One of: "available", "beta", "coming_soon". |
Response
200. The payload in data is of type object.
Archive my developer app
DELETE/app-builder/apps/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Take back my app's capability change that is waiting for review
DELETE/app-builder/apps/{id}/capability-request
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is of type object.
My app's capability versions, newest first (approved, pending review, rejected, withdrawn)
GET/app-builder/apps/{id}/capability-versions
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. data is object[].
Ask the platform channel to review the app for the Store
POST/app-builder/apps/{id}/submit
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is of type object.
My business's developer apps
GET/app-builder/businesses/{businessId}/apps
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path |
Response
200. data is object[].
Create an app (private to your channels until its review is approved)
POST/app-builder/businesses/{businessId}/apps
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| package_name | string | Reverse-DNS package name, unique in the Store (required to create) At least 3 characters, at most 120 characters. Example: "com.example.orders" |
| key | string | Stable key (a-z, 0-9, -). The platform's own apps only; others get one. Example: "orders" |
| name | string | At least 2 characters, at most 80 characters. Example: "Multivendor" |
| description | string | At least 0 characters, at most 500 characters. |
| category | string | At least 0 characters, at most 60 characters. Example: "Commerce" |
| icon | string | At least 0 characters, at most 40 characters. Example: "cart" |
| color | string | Example: "#16A34A" |
| capabilities | string[] | Capability keys (GET /app-builder/capabilities) |
| price_gbp_minor | number | Monthly GBP price in pence; 0 = free Minimum 0. Example: 2499 |
| price_usd_minor | number | Monthly USD price in cents; 0 = free Minimum 0. Example: 2999 |
| homepage_url | string | |
| webhook_url | string | |
| availability | string | The platform's own apps only; ignored for others One of: "available", "beta", "coming_soon". |
Response
201. The payload in data is of type object.
Every capability an app can bundle (key, label, panel nav, API prefixes)
GET/app-builder/capabilities
Public: no sign-in needed.
Response
200. data is object[].