{"@context": "https://schema.org", "@type": "WebAPI", "name": "Rocket Services API", "description": "An Orchestration Layer that takes ISL services and packages them in a more targeted way for front-end applications. This in turn makes client integration easier and reduces the complexity and size of front-end applications. Rocket is also customisable - allowing UI engineers to ‘remix’ the existing", "provider": {"@type": "Organization", "name": "britbox.co.uk"}, "documentation": "https://isl.britbox.co.uk/api/spec"}
An Orchestration Layer that takes ISL services and packages them in a more targeted way for front-end applications. This in turn makes client integration easier and reduces the complexity and size of front-end applications. Rocket is also customisable - allowing UI engineers to ‘remix’ the existing
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
An Orchestration Layer that takes ISL services and packages them in a more targeted way for front-end applications. This in turn makes client integration easier and reduces the complexity and size of front-end applications. Rocket is also customisable - allowing UI engineers to ‘remix’ the existing back-end services into something that best suits the application they are developing.
| method | path | what the vendor says it does |
|---|---|---|
GET | /account | Get the details of an account along with the profiles and entitlements under it. account |
PATCH | /account | Update the details of an account. With the exception of the address, this supports partial updates, so you ca |
GET | /account/billing/methods | Get the available payment methods under an account. account |
POST | /account/billing/methods | Add a new payment method to an account. account |
GET | /account/billing/methods/{id} | Get a payment method under an account. account |
DELETE | /account/billing/methods/{id} | Remove a payment method from an account. account |
GET | /account/billing/purchases | Get a list of all purchases made under an account. account |
POST | /account/billing/purchases | Purchase a plan or item offer. The result of a successful transaction is a new entitlement. account |
PUT | /account/billing/subscriptions/{id} | Renew a cancelled subscription or switch subscription to a different plan. When renewing a cancelled subscrip |
DELETE | /account/billing/subscriptions/{id} | Cancel a plan subscription. A cancelled subscription will continue to be valid until the subscription expiry |
GET | /account/devices | Get all devices registered under this account. Also includes information around device registration and dereg |
POST | /account/devices | Register a playback device under an account. If a device with the same id already exists a `409` conflict wil |
POST | /account/devices/authorization | Authorize a device from a generated device authorization code. This is the second step in the process of auth |
GET | /account/devices/{id} | Get a registered device. account |
DELETE | /account/devices/{id} | Deregister a playback device from an account. account |
PUT | /account/devices/{id}/name | Rename a device account |
GET | /account/entitlements | Get all entitlements under the account. This list is returned under the call to get account information so a |
GET | /account/items/{id}/videos | Get the video files associated with an item given maximum resolution, device type and one or more delivery typ |
GET | /account/items/{id}/videos-guarded | Get the video files associated with an item given maximum resolution, device type and one or more delivery typ |
GET | /account/nonce | Generate a new account nonce. A nonce may be required to help sign a response from a third party service whic |
PUT | /account/password | Change the password of an account. The expected token scope is Settings. account |
PUT | /account/pin | Change the pin of an account. account |
GET | /account/profile | Get the details of the active profile, including watched, bookmarked and rated items. profile |
GET | /account/profile/bookmarks | Get the map of bookmarked item ids (itemId => creationDate) under the active profile. profile |
GET | /account/profile/bookmarks/list | Returns the list of bookmarked items under the active profile. profile |
GET | /account/profile/bookmarks/{itemId} | Get the bookmark for an item under the active profile. profile |
PUT | /account/profile/bookmarks/{itemId} | Bookmark an item under the active profile. Creates one if it doesn't exist, overwrites one if it does. profil |
DELETE | /account/profile/bookmarks/{itemId} | Unbookmark an item under the active profile. profile |
GET | /account/profile/continue-watching/list | Returns a list of items which have been watched but not completed under the active profile. Multiple episodes |
GET | /account/profile/items/{itemId}/next | Returns the next item to play given a source item id. For an unwatched show it returns the first episode avai |
GET | /account/profile/ratings | Get the map of rated item ids (itemId => rating out of 10) under the active profile. profile |
GET | /account/profile/ratings/list | Returns the list of rated items under the active profile. profile |
GET | /account/profile/ratings/{itemId} | Get the rating info for an item under the active profile. profile |
PUT | /account/profile/ratings/{itemId} | Rate an item under the active profile. Creates one if it doesn't exist, overwrites one if it does. profile |
GET | /account/profile/watched | Get the map of watched item ids (itemId => last playhead position) under the active profile. profile |
DELETE | /account/profile/watched | Remove the watched status of items under the active profile. Passing in specific `itemId`s to the `item_ids` q |
GET | /account/profile/watched/list | Returns the list of watched items under the active profile. profile |
GET | /account/profile/watched/{itemId} | Get the watched status info for an item under the active profile. profile |
PUT | /account/profile/watched/{itemId} | Record the watched playhead position of a video under the active profile. Can be used later to resume a video |
POST | /account/profiles | Create a new profile under the active account. account |
and 81 more operation(s) in this specification, all searchable.
specification origin: https://isl.britbox.co.uk/api/spec
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.