Why can’t I see API products in the production environment when building an app?
FAQ item
API products in the production environment are only visible in the app creation process to developers who have the appropriate authorization. If you can’t see a product that you think that you should have access to, please contact your account manager.
How do I use the API key and secret to call an API?
FAQ item
Most of our external APIs are authenticated with an OAuth token which is generated using the OAuth API. To produce the authorisation string for the OAuth request, the app's client ID, ':' and password are concatenated and base64-encoded. This string is…
How much does it cost to use this site?
FAQ item
Using the developer portal and sandbox APIs is free of charge. Access to live APIs in our production environment are subject to contractual agreement which will specify the commercial terms for API usage.
How are APIs billed / paid for?
FAQ item
Where APIs are chargeable, they are billed under a billing agreement that forms part of our overall commercial contract. Please contact your account manager for more information.
What is the difference between sandbox and production APIs?
FAQ item
Our sandbox APIs emulate the live environment and give you the opportunity to send test API calls and to receive a simulated response. The production APIs work with our live systems and data.
Do our APIs work with other mobile operators?
FAQ item
Our APIs are designed to work with BT brands only, these include EE, BT and Plusnet. Some APIs support information for MVNOs on our mobile network. Not all of our brands are supported by all APIs – please check the relevant API documentation.
What types of services do your APIs provide?
FAQ item
Our APIs provide a wide range of services relating to both our company’s products and managing interactions with our customers.
How do I find out my quota limits for the production environment?
FAQ item
Depending on how you propose to use our APIs, we may enforce a quota for usage in production. This will be agreed as part of our commercial contract.
How do I access live data?
FAQ item
Live data is only available to organisations with an appropriate contractual agreement. Please contact our account management teams via ‘Contact us’ for further details.
How do I get help with a fault or issue?
FAQ item
Please try to resolve your issue by reading articles in the Knowledge Centre. If you can't find a solution, please use the form in the ‘Contact us’ section.
Why is my app approval status showing as “Pending”?
FAQ item
Apps in the production environment give access to live systems or live data and may require approval / configuration before going live. Please contact you account manager if you are concerned about any delay with your app.
Are there any quota limits on the sandbox environment?
FAQ item
We reserve the right to put limits on the volume of calls made to our sandbox and we believe that customers will be able to create and test their apps in the sandbox without hitting any usage limits.
Authentication
Product Documentation
OAuth 2 produces an access token which is required to authorise API calls for a given app.
Product codes and attributes
API Basic page
Introduction
A Broadband One order comprises an access product offering, and several associated product offerings.
Each product offering is represented in the Broadband One order by an id value in a product.productOffering object
Access technology…
Mandatory country documentation
API Basic page
Mandatory country documents
File
CPaaS Mandatory Documents.pdf
(119.94 KB)
Homepage
Page Builder
Homepage
Why partner with us?
We have more than 32m customers in the UK, over 620 high street stores and a presence…
Location Insights for UK
Product
Access insights on footfall activity and visitor catchments across selected locations in the UK
The Location Insights API provides data on footfall and home catchment for key retail locations and custom areas of interest (AoIs) in the UK.
Response codes
API Basic page
Introduction
Some product order state change events (KSUs) have associated codes and messages from the underlying WBC notifications. It is important to understand these directly relate to the WBC order and only indirectly relate to the subsequent state of…
Sim Swap - CAMARA
Proxy Specification
API interface is used by an application to get information about a mobile line latest SIM swap date. It can be easily integrated and used through this secured API and allows SPs (Service Provider) to get this information an easy…
SIM SWAP - CAMARA
Product
SIM Swap – CAMARA enables service providers to detect recent SIM changes on a mobile line, helping prevent account takeover and fraud during sensitive transactions.
The SIM Swap API provides real-time access to information about the most recent SIM card change associated with a mobile number. It supports two key functions: retrieving the exact timestamp of the last SIM swap, and checking whether a SIM change occurred…
Outage Analytics
Product
Provides intelligence on outages across BT GeoMND network
Overview
The Outage Analytics API provides details on observed areas and/or time periods where BT's GeoMND network has observed outages along with their relative significance to support adjacent reporting.
Real-Time Location Insights
Product
Provide people count estimates within an area within 10 minutes.
Overview
The Real-time Location Insights APIs provide population count estimates within an area in near real time. There are two APIs within our Real-Time Location Insights:
1. The census API provides data aggregated to a minimum geography of Lower…
Order Examples
API Basic page
Provide
ADSL Migration using DN Self Install
Click to view
{
"externalId": "ADSL Migration using DN Self Install 24M",
"requestedCompletionDate": "2022-11-04T00:00:00Z",
"productOrderItem": [
{
"id": "100",
"…
Etherflow Internet (DIA)
API Basic page
Product Display Name on Business Zone
Current Online Journey
Product Alias Name - API Journey
Comments
Etherflow - Internet
Etherflow - Internet
…
KSU Examples
API Basic page
Provide
Product Order Create Event
Click to view
{
"event": {
"productOrder": {
"externalId": "13008684",
"id": "00125420",
"productOrderItem": [
{
"action": "add…
Back to top