Apps
10 routes. Paths are relative to https://api.intersink.com/v1.
- GET/appsList published apps. Query: ?q=&page=&limit= (max 100)
- GET/apps/{id}Get an app by id
- GET/apps/{id}/reviewsAn app's reviews, newest first, with its average rating
- POST/apps/{id}/reviewsRate and review an app (1–5). Only managers of a channel that runs it; one review per person, replaced on repeat
- DELETE/apps/{id}/reviewsDelete your review of an app
- GET/apps/channelList apps installed on a channel: ?channel_id=, else x-ref, else your token's channel. Only a channel you can read: a live channel, or one you manage
- POST/apps/channelInstall an app into a channel you manage (body channel_id, else your token's channel)
- DELETE/apps/channel/{channelId}/{appId}Uninstall an app from a channel (link archived, not deleted)
- GET/apps/channel/{channelId}/{appId}/accessWhich channel roles can use an installed app
- PUT/apps/channel/{channelId}/{appId}/accessSet the channel roles that can use an installed app (others lose access)
List published apps. Query: ?q=&page=&limit= (max 100)
GET/apps
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| q | string, query | At most 100 characters. |
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
Response
200. The payload in data is not described in the spec yet.
Get an app by id
GET/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.
An app's reviews, newest first, with its average rating
GET/apps/{id}/reviews
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Rate and review an app (1–5). Only managers of a channel that runs it; one review per person, replaced on repeat
POST/apps/{id}/reviews
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 |
|---|---|---|
| ratingrequired | number | Minimum 1, maximum 5. |
| title | string | At most 120 characters. |
| text | string | At most 2000 characters. |
Response
201. The payload in data is not described in the spec yet.
Delete your review of an app
DELETE/apps/{id}/reviews
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.
List apps installed on a channel: ?channel_id=, else x-ref, else your token's channel. Only a channel you can read: a live channel, or one you manage
GET/apps/channel
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channel_id | string, query | The channel to read (UUID) |
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
Install an app into a channel you manage (body channel_id, else your token's channel)
POST/apps/channel
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| app_idrequired | string | Id of the app to link to the channel |
| channel_id | string | Channel to install into. Defaults to the channel in your token; you must manage it. |
| plan_id | string | Plan to buy (GET /billing/plans). Required for apps sold on plans; billed daily to the channel's business. |
Response
201. The payload in data is not described in the spec yet.
Uninstall an app from a channel (link archived, not deleted)
DELETE/apps/channel/{channelId}/{appId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path | |
| appIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Which channel roles can use an installed app
GET/apps/channel/{channelId}/{appId}/access
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| appIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Set the channel roles that can use an installed app (others lose access)
PUT/apps/channel/{channelId}/{appId}/access
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| appIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| role_idsrequired | string[] | Channel roles that may use the app. Roles not listed lose access. |
Response
200. The payload in data is not described in the spec yet.