Developer program
10 routes. Paths are relative to https://api.intersink.com/v1.
- GET/developer-program/businesses/{businessId}Can the business join, its developer account, the fee and Marketplace eligibility
- GET/developer-program/businesses/{businessId}/projectsThe business's projects
- POST/developer-program/businesses/{businessId}/projectsStart a project (a draft; active developers only)
- POST/developer-program/businesses/{businessId}/registerJoin (businesses created on Intersink): accepts the terms, charges the annual fee, then waits for review
- GET/developer-program/projects/{id}One project
- PATCH/developer-program/projects/{id}Change the request (an approved project then waits for review again)
- POST/developer-program/projects/{id}/checkupConfirm the annual data use checkup (overdue: live keys pause)
- POST/developer-program/projects/{id}/submitSend the project for review (accepts the API policy)
- GET/developer-program/projects/{id}/usageThis month's API requests and the free allowance
- GET/developer-program/scopesScopes a project can ask for, with what each allows
Can the business join, its developer account, the fee and Marketplace eligibility
GET/developer-program/businesses/{businessId}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
The business's projects
GET/developer-program/businesses/{businessId}/projects
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path |
Response
200. data is object[].
Start a project (a draft; active developers only)
POST/developer-program/businesses/{businessId}/projects
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 |
|---|---|---|
| name | string | At least 2 characters, at most 80 characters. Example: "Warehouse sync" |
| description | string | One or two sentences about it At least 0 characters, at most 1000 characters. |
| use_case | string | What you build with the API and for whom (the review reads it) At least 0 characters, at most 5000 characters. |
| project_url | string | Example: "https://acme.example" |
| privacy_url | string | Example: "https://acme.example/privacy" |
| contact_name | string | At least 0 characters, at most 120 characters. |
| contact_phone | string | A number the review team can call At least 0 characters, at most 40 characters. |
| domains | string[] | |
| scopes | string[] | One of: "products:read", "products:write", "orders:read", "orders:write", "customers:read", "crm:read", "crm:write", "e2ee:gateway", "channel:config:read", "releases:write", "updates:write", "profile_data:read", "search:read", "search:write", "search:admin", "media:read", "media:write", "features:read", "features:write", "jobs:apply". |
| channel_ids | string[] | Channels of your own business it works on |
Response
200. The payload in data is of type object.
Join (businesses created on Intersink): accepts the terms, charges the annual fee, then waits for review
POST/developer-program/businesses/{businessId}/register
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 |
|---|---|---|
| display_namerequired | string | Shown as the publisher in the Store At least 2 characters, at most 120 characters. Example: "Acme Apps" |
| contact_email | string | Example: "dev@acme.example" |
| website | string | Example: "https://acme.example" |
| accept_termsrequired | boolean | Accepts the developer terms and API policy (required) |
Response
200. The payload in data is not described in the spec yet.
One project
GET/developer-program/projects/{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 of type object.
Change the request (an approved project then waits for review again)
PATCH/developer-program/projects/{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 |
|---|---|---|
| name | string | At least 2 characters, at most 80 characters. Example: "Warehouse sync" |
| description | string | One or two sentences about it At least 0 characters, at most 1000 characters. |
| use_case | string | What you build with the API and for whom (the review reads it) At least 0 characters, at most 5000 characters. |
| project_url | string | Example: "https://acme.example" |
| privacy_url | string | Example: "https://acme.example/privacy" |
| contact_name | string | At least 0 characters, at most 120 characters. |
| contact_phone | string | A number the review team can call At least 0 characters, at most 40 characters. |
| domains | string[] | |
| scopes | string[] | One of: "products:read", "products:write", "orders:read", "orders:write", "customers:read", "crm:read", "crm:write", "e2ee:gateway", "channel:config:read", "releases:write", "updates:write", "profile_data:read", "search:read", "search:write", "search:admin", "media:read", "media:write", "features:read", "features:write", "jobs:apply". |
| channel_ids | string[] | Channels of your own business it works on |
Response
200. The payload in data is of type object.
Confirm the annual data use checkup (overdue: live keys pause)
POST/developer-program/projects/{id}/checkup
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 |
|---|---|---|
| accept_termsrequired | boolean | Accepts the current API policy |
| still_accuraterequired | boolean | The project still does what was approved |
| use_case | string | An updated description of what it does At least 0 characters, at most 5000 characters. |
Response
200. The payload in data is of type object.
Send the project for review (accepts the API policy)
POST/developer-program/projects/{id}/submit
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 |
|---|---|---|
| accept_termsrequired | boolean | Accepts the API policy and developer terms |
Response
200. The payload in data is of type object.
This month's API requests and the free allowance
GET/developer-program/projects/{id}/usage
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.
Scopes a project can ask for, with what each allows
GET/developer-program/scopes
Needs a signed-in user (Bearer token or access_token cookie).
Response
200. The payload in data is not described in the spec yet.