Britbox

Rocket Services

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…

Media & content#openapi#entertainment

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 121

account

  • GETgetAccount/account?ff=all&lang=stringGet the details of an account along with the profiles and entitlements under it.
  • PATCHupdateAccount/account?ff=all&lang=stringUpdate the details of an account. With the exception of the address, this supports partial updates, so you can send just the properties you wish to update.…
  • GETgetPaymentMethods/account/billing/methods?ff=all&lang=stringGet the available payment methods under an account.
  • POSTaddPaymentMethod/account/billing/methods?ff=all&lang=stringAdd a new payment method to an account.
  • GETgetPaymentMethod/account/billing/methods/:id?ff=all&lang=stringGet a payment method under an account.
  • DELETEremovePaymentMethod/account/billing/methods/:id?ff=all&lang=stringRemove a payment method from an account.
  • GETgetPurchases/account/billing/purchases?ff=all&lang=stringGet a list of all purchases made under an account.
  • POSTmakePurchase/account/billing/purchases?ff=all&lang=stringPurchase a plan or item offer. The result of a successful transaction is a new entitlement.
  • PUTupdateSubscription/account/billing/subscriptions/:id?planId=string&ff=all&lang=stringRenew a cancelled subscription or switch subscription to a different plan. When renewing a cancelled subscription membership, hit this endpoint with the id of…
  • DELETEcancelSubscription/account/billing/subscriptions/:id?ff=all&lang=stringCancel a plan subscription. A cancelled subscription will continue to be valid until the subscription expiry date or next renewal date.
  • GETgetDevices/account/devices?ff=all&lang=stringGet all devices registered under this account. Also includes information around device registration and deregistration limits.
  • POSTregisterDevice/account/devices?ff=all&lang=stringRegister a playback device under an account. If a device with the same id already exists a 409 conflict will be returned.
  • POSTauthorizeDevice/account/devices/authorization?ff=all&lang=stringAuthorize a device from a generated device authorization code. This is the second step in the process of authorizing a device by pin code. Firstly the device…
  • GETgetDevice/account/devices/:id?ff=all&lang=stringGet a registered device.
  • DELETEderegisterDevice/account/devices/:id?ff=all&lang=stringDeregister a playback device from an account.
  • PUTrenameDevice/account/devices/:id/name?name=string&ff=all&lang=stringRename a device
  • GETgetEntitlements/account/entitlements?ff=all&lang=stringGet all entitlements under the account. This list is returned under the call to get account information so a call here is only required when wishing to…
  • GETgetItemMediaFiles/account/items/:id/videos?delivery=stream&resolution=HD-4K&formats=mp4&device=web_browser&sub=string&segments=string&ff=all&lang=stringGet the video files associated with an item given maximum resolution, device type and one or more delivery types. This endpoint accepts an Account Catalog…
  • GETgetItemMediaFilesGuarded/account/items/:id/videos-guarded?delivery=stream&resolution=HD-4K&formats=mp4&device=web_browser&sub=string&segments=string&ff=all&lang=stringGet the video files associated with an item given maximum resolution, device type and one or more delivery types. This endpoint is identical to the…
  • GETgenerateNonce/account/nonce?ff=all&lang=stringGenerate a new account nonce. A nonce may be required to help sign a response from a third party service which will be passed back to these services. For…
  • PUTchangePassword/account/password?ff=all&lang=stringChange the password of an account. The expected token scope is Settings.
  • PUTchangePin/account/pin?ff=all&lang=stringChange the pin of an account.
  • POSTcreateProfile/account/profiles?ff=all&lang=stringCreate a new profile under the active account.
  • GETgetProfileWithId/account/profiles/:id?ff=all&lang=stringGet the summary of a profile with a specific id under the active account.
  • DELETEdeleteProfileWithId/account/profiles/:id?ff=all&lang=stringDelete a profile with a specific id under the active account. Note that you cannot delete the primary profile.
  • PATCHupdateProfileWithId/account/profiles/:id?ff=all&lang=stringUpdate the summary of a profile with a specific id under the active account. This supports partial updates so you can send just the properties you wish to…
  • POSTrequestEmailVerification/account/request-email-verification?ff=all&lang=stringRequest that the email address tied to an account be verified. This will send a verification email to the email address of the primary profile containing a…

profile

  • GETgetProfile/account/profile?ff=all&lang=stringGet the details of the active profile, including watched, bookmarked and rated items.
  • GETgetBookmarks/account/profile/bookmarks?ff=all&lang=stringGet the map of bookmarked item ids (itemId => creationDate) under the active profile.
  • GETgetBookmarkList/account/profile/bookmarks/list?page=1&page_size=1&order=desc&item_type=movie&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns the list of bookmarked items under the active profile.
  • GETgetItemBookmark/account/profile/bookmarks/:itemId?ff=all&lang=stringGet the bookmark for an item under the active profile.
  • PUTbookmarkItem/account/profile/bookmarks/:itemId?ff=all&lang=stringBookmark an item under the active profile. Creates one if it doesn't exist, overwrites one if it does.
  • DELETEdeleteItemBookmark/account/profile/bookmarks/:itemId?ff=all&lang=stringUnbookmark an item under the active profile.
  • GETgetContinueWatchingList/account/profile/continue-watching/list?show_item_type=episode&include=&page=1&page_size=12&max_rating=string&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns a list of items which have been watched but not completed under the active profile. Multiple episodes under the same show may be watched or in…
  • GETgetNextPlaybackItem/account/profile/items/:itemId/next?max_rating=string&expand=parent&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns the next item to play given a source item id. For an unwatched show it returns the first episode available to the account. For a watched show it…
  • GETgetRatings/account/profile/ratings?ff=all&lang=stringGet the map of rated item ids (itemId => rating out of 10) under the active profile.
  • GETgetRatingsList/account/profile/ratings/list?page=1&page_size=12&order=desc&order_by=date-added&item_type=movie&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns the list of rated items under the active profile.
  • GETgetItemRating/account/profile/ratings/:itemId?ff=all&lang=stringGet the rating info for an item under the active profile.
  • PUTrateItem/account/profile/ratings/:itemId?rating=1&ff=all&lang=stringRate an item under the active profile. Creates one if it doesn't exist, overwrites one if it does.
  • GETgetWatched/account/profile/watched?ff=all&lang=stringGet the map of watched item ids (itemId => last playhead position) under the active profile.
  • DELETEdeleteWatched/account/profile/watched?item_ids=string&ff=all&lang=stringRemove the watched status of items under the active profile. Passing in specific itemIds to the item_ids query parameter will cause only these items to be…
  • GETgetWatchedList/account/profile/watched/list?page=1&page_size=12&completed=true&order=desc&order_by=date-added&item_type=movie&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns the list of watched items under the active profile.
  • GETgetItemWatchedStatus/account/profile/watched/:itemId?ff=all&lang=stringGet the watched status info for an item under the active profile.
  • PUTsetItemWatchedStatus/account/profile/watched/:itemId?position=0&ff=all&lang=stringRecord the watched playhead position of a video under the active profile. Can be used later to resume a video from where it was last watched. Creates one if…

authorization

  • POSTgetAccountToken/authorization?ff=all&lang=stringRequest one or more Account level authorization tokens each with a chosen scope. Tokens are used to access restricted service endpoints. These restricted…
  • DELETEsignOut/authorization?ff=all&lang=stringWhen a user signs out of an application we need to clear some basic cookies we assigned them during token authorization.
  • POSTgetAccountTokenByCode/authorization/device?ff=all&lang=stringGet Catalog tokens for an account using a device authorization code. Where a Profile level token of Catalog scope exists it will also be returned. This is the…
  • POSTgenerateDeviceAuthorizationCode/authorization/device/code?ff=all&lang=stringGet a generated device authorization code. This is the first step in the process of authorizing a device by pin code. The device will make a request to this…
  • POSTgetProfileToken/authorization/profile?ff=all&lang=stringRequest one or more Profile level authorization tokens each with a chosen scope. Tokens are used to access restricted service endpoints. These restriced…
  • POSTrefreshToken/authorization/refresh?ff=all&lang=stringRefresh an account or profile level authorization token which is marked as refreshable.
  • POSTsingleSignOn/authorization/sso?ff=all&lang=stringExchange a third party single-sign-on token for our own authorization tokens.

bt

  • GETgetPlanByToken/bt/plan/:token?lang=stringReturns all the plans available for BT flow including additional description data.
  • GETgetPlans/bt/plans?lang=stringReturns all the plans available for BT flow including additional description data.
  • POSTassignToken/bt/token/assign?lang=stringAssigns an UserToken to a profile on the ITV side. Currently throws an exception.
  • GETcheckUserToken/bt/token/validate?id=string&ff=all&lang=stringChecks a provided token for BT eligible user.

support

  • GETgetSubscriptionData/check-subscription/:idReturns the details of subscription data for a user with specified id.
  • POSTforgotPassword/request-password-reset?ff=all&lang=stringRequest the password of an account's primary profile be reset. Should be called when a user has forgotten their password. This will send an email with a…
  • POSTresetPassword/reset-password?ff=all&lang=stringWhen a user requests to reset their password via the /request-password-reset endpoint, an email is sent to the email address of the primary profile of the…
  • POSTverifyEmail/verify-email?ff=all&lang=stringWhen an account is created an email is sent to the email address of the new account. This contains a link, which once clicked, verifies the email address of…

app

  • GETgetAppConfig/config?include=classification&system=string&device=web_browser&sub=string&segments=string&ff=all&lang=stringGet the global configuration for an application. Should be called during app statup. This includes things like device and playback rules, classifications,…
  • GETgetItvPage/itv/page?path=string&list_page_size=12&list_page_size_large=50&max_list_prefetch=2&item_detail_expand=all&item_detail_select_season=first&text_entry_format=markdown&max_rating=string&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns a page with the specified id. This is a cut down version for low memory devices.123 If targeting the search page you must url encode the search term…
  • GETgetPage/page?path=string&list_page_size=12&list_page_size_large=50&max_list_prefetch=2&item_detail_expand=all&item_detail_select_season=first&text_entry_format=markdown&max_rating=string&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns a page with the specified id. If targeting the search page you must url encode the search term as a parameter using the q key. For example if your…

ee

  • GETcheckEeBtEligibility/ee-bt/eligibility?lang=stringCheck whether or not a user is eligible for switching to Bt or EE offers.
  • POSTassignMsisdn/ee/msisdn?lang=stringAssigns a msisdn to a profile on ITV side.
  • POSTgetEligibleOffers/ee/offers?ff=all&lang=stringReturns eligible partner specific offers for the querying partner for an EE MSISDN. This call is supposed to be called after we have MSISDN accired. This call…
  • PUTcreatePinRequest/ee/pin?ff=all&lang=stringCreates a PIN request that will send an SMS to the given msisdn. This call is to validate MSISDN entered by a user not comming through EE network. This call…
  • POSTvalidatePinRequest/ee/pin?ff=all&lang=stringValidate PIN request created by calling POST /ee/pin This call is to validate MSISDN entered by a user not comming through EE network. This call should be…
  • GETGET /ee/plans/ee/plans?lang=stringReturns all the plans available for EE flow including additional description data.
  • GETgetPlan/ee/plans/:id?lang=stringReturns the plan description for EE flow including additional description data.
  • GETcreateToken/ee/token/createReturns a token for later calls to EE API. TTL is one hour. Recommended is FE refreshes this token before each call.

content

  • GETgetItem/items/:id?max_rating=string&expand=all&select_season=first&use_custom_id=true&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns the details of an item with the specified id.
  • GETgetItemChildrenList/items/:id/children?page=1&page_size=12&max_rating=string&order=desc&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns the List of child summary items under an item. If the item is a Season then the children will be episodes and ordered by episode number. If the item…
  • GETgetItemRelatedList/items/:id/related?page=1&page_size=12&max_rating=string&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns the list of items related to the parent item. Note for now, due to the size of the list being unknown, only a single page will be returned.
  • GETgetPublicItemMediaFiles/items/:id/videos?delivery=stream&resolution=HD-4K&formats=mp4&device=web_browser&sub=string&segments=string&ff=all&lang=stringGet the free / public video files associated with an item given maximum resolution, device type and one or more delivery types. Returns an array of video file…
  • GETgetAnonNextPlaybackItem/items/:itemId/next?max_rating=string&expand=parent&device=web_browser&segments=string&ff=all&lang=stringIdentical to GET /account/profile/items/{itemId}/next route but for users that are not logged in i.e. this endpoint does not require authorisation
  • POSTgetItemsMediaClipFiles/itv/items/clips?ff=all&lang=stringGet the media clip files associated with items.
  • POSTgetItemDownloadables/itv/items/downloadable?ff=all&lang=stringReturns the details of an item with the specified id.
  • GETgetLists/lists?ids=string&page_size=12&max_rating=string&order=desc&order_by=a-z&item_type=movie&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns an array of item lists with their first page of content resolved.
  • GETgetList/lists/:id?page=1&page_size=12&max_rating=string&order=desc&order_by=a-z&param=string&item_type=movie&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns a list of items under the specified item list
  • GETGET /plans/{id}/plans/:id?device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns the details of a Plan with the specified id.
  • GETgetSchedules/schedules?channels=string&date=2024-01-01&hour=0&duration=0&intersect=false&device=web_browser&sub=string&segments=string&ff=all&lang=stringReturns schedules for a defined set of channels over a requested period. Schedules are requested in hour blocks and returned grouped by the channel they…
  • GETsearch/search?term=string&include=tv&group=true&max_results=20&max_rating=string&device=web_browser&sub=string&segments=string&ff=all&lang=stringSearch the catalog of items and people.

itv

  • POSTgetBillingHistory/itv/billinghistory/:platform?lang=stringReturns the list of billing records for specified payment platform.
  • PUTchangeCardDetails/itv/cards/:platform?lang=stringChange payment card details.
  • POSTgetCardDetails/itv/cards/:platform?lang=stringGet payment card details.
  • POSTchangeEmail/itv/changeemail?ff=all&lang=stringChange email address related to account/profile. The expected token scope is Settings.
  • POSTchangeMarketing/itv/changemarketing?ff=all&lang=stringChange marketing preferences related to account/profile. The expected token scope is Settings.
  • POSTdeleteAccount/itv/deleteaccount?ff=all&lang=stringDelete account in compliance with GDPR. The expected token scope is Settings.
  • GETgetCurrentEntitlement/itv/entitlements/current?lang=stringReturns current entitlement.
  • GETgetEntitlementsHistory/itv/entitlements/history?lang=stringReturns the state of subscription for any payment platform.
  • GETgetFeatureFlag/itv/featureFlag/:feature?lang=stringGets info whether or not a feature is enabled or disabled using a feature flag. Feature flags are set as a custom field within PM. It also supports custom…
  • POSTgooglePaySubscription/itv/googlepay/subscription?lang=stringGet the list of recommended items under the active profile.
  • GETcheckPreviousEntitlements/itv/had/entitlements?lang=stringCheck whether the user has been previously entitled.
  • GETGET /itv/itemsummary/{externalId}/itv/itemsummary/:externalIdRedirects to corresponding Axis Item details page.
  • POSTgetAccountTokenWithPin/itv/pinauthorization?ff=all&lang=stringProvides authorization with parental control pin. Returns an array containing account token with Playback scope. Requires access token with Catalog scope. Pin…
  • POSTupgradePlan/itv/plan/:platform?lang=stringUpgrades the plan for the current user.
  • GETGET /itv/plans/{platform}/itv/plans/:platform?lang=stringReturns the plans available for specified payment platform.
  • GETGET /itv/profile/itv/profile?lang=stringReturns the ITV profile object.
  • PUTupdateProfile/itv/profile?ff=all&lang=stringUpdate ITV profile. The expected token scope is Settings.
  • GETgetRecommendedList/itv/profile/recommendation/list?item_types={"item_types":"show,movie"}&page=1&page_size=12&device=web_browser&sub=string&segments=string&ff=all&lang=stringGet the list of recommended items under the active profile.
  • POSTgetItvProfileToken/itv/profiletoken?lang=stringReturns the ITV profile token.
  • GETgetCurrentSubscription/itv/purchase/:platform?lang=stringReturns the details of current subscription for specified payment platform.
  • POSTconfirmPurchase/itv/purchase/:platform?lang=stringConfirms purchase and returns the details of purchased subscription for specified payment platform.
  • DELETEDELETE /itv/purchase/{platform}/itv/purchase/:platform?lang=stringCancel a plan subscription. A cancelled subscription will continue to be valid until the subscription expiry date or next renewal date.
  • POSTconfirmPurchaseStrong/itv/purchase/:platform/strong?lang=stringConfirms purchase and returns the details of purchased subscription for specified payment platform.
  • POSTconfirmPurchaseWithOffer/itv/purchase/:platform/withoffer?lang=stringConfirms purchase and returns the details of purchased subscription for specified payment platform.
  • POSTresubscribe/itv/resubscribe/:platform?planId=string&lang=stringResubscription for a user.
  • GETGET /itv/roku/plans/itv/roku/plans?lang=stringGets available Roku plans.
  • POSTexecuteTransaction/itv/roku/transaction/:transactionid?lang=stringSends request to execute specified transaction.
  • GETgetSaveOffer/itv/save-offer?lang=stringChecks the provided coupon id for a user. Only Stripe platform is currently supported.
  • POSTactivateSaveOffer/itv/save-offer?lang=stringActivates the discount for a user. Only Stripe platform is currently supported.
  • GETgetFullPriceRenewal/itv/subscription/fullpricerenewal?lang=stringReturns full price renewal state and reason for specific user.
  • GETgetSubscriptionStatus/itv/subscription/status/:platform?lang=stringReturns status of latest payment intent.
  • GETgetSubscriptionState/itv/subscriptionstate?lang=stringReturns the state of subscription for any payment platform.
  • GETgetUpcomingInvoice/itv/upcominginvoice?lang=stringReturns an upcoming invoice
  • PUTupdatePaymentIntentStrong/itv/updateIntent/strong/:platform?lang=stringChange payment method details.
  • PUTupdatePaymentMethodStrong/itv/updatePayment/strong/:platform?lang=stringChange payment method details.
  • GETgetVoucherById/itv/voucher/:planId/:voucherId?lang=stringChecks the provided coupon id for a user. Only Stripe platform is currently supported.
  • POSTcheckVoucher/itv/voucher/:platform?lang=stringValidates the coupon/voucher for specified payment platform.
  • GETgetPublicPreview/samsung-previewReturns public preview for Samsung based on the page '/samsung-preview' configured in PresentationManager. There is a hard limit of max 40 items to be…

registration

  • POSTregister/register?ff=all&lang=stringRegister a new user, creating them an account. Registration, when successful, will return an array of access tokens so the user is immediately signed in. It…

API details

Authentication
OAuth 2.0 (password flow) with 4 scopes
OAuth 2.0 (password flow) with 1 scope
An API key in the authorization header
An API key in the authorization header
Operations
121 operations on 100 pathsGET 61POST 38PUT 12DELETE 8PATCH 2
Main resources
itv 38account 27profile 17content 12ee 8authorization 7bt 5support 4app 3registration 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 3.730.300-ref-1-39-0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Rocket Services in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Rocket Services collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (password flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getAccount” (GET /account?ff=all&lang=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Rocket Services?

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… It is listed under Media & content and has 121 endpoints.

Who publishes the Rocket Services?

It is listed from Britbox's public API description (an OpenAPI document), not published by Britbox on Swastik Codes. Anyone who controls britbox.co.uk can claim the profile by adding a DNS TXT record.

How do I authenticate with the Rocket Services?

It accepts 4 methods: OAuth 2.0 (password flow) with 4 scopes; OAuth 2.0 (password flow) with 1 scope; an API key in the authorization header; an API key in the authorization header.

How many endpoints does the Rocket Services have?

121 operations on 100 paths (61 GET, 38 POST, 12 PUT, 8 DELETE, 2 PATCH). The largest groups are itv, account, profile, content.

Is forking the Rocket Services free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.