Why can’t I see API products in the production environment when building an app?
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?
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?
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?
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?
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?
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?
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?
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?
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?
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”?
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?
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.
This API product allows a developer to search for a specific postal address using detailed information (such as a house number + postcode) or return a candidate list of addresses.
Generic Numbering API
Generic Numbering API facilitates you to place Number Management and Numbering Porting orders. Order and allocate, activation, deallocation, deactivation & DirectActivation new number. Create, amend and cancel an order to port in a SingleLine/…
Address Management (Ethernet)
Set an address using a UK postcode, or manually create a temporary one, before placing an order.
This product confirms an outbound call is going to its intended number, and isn’t being diverted to a potentially fraudulent one – giving customers more security and greater peace of mind.
Encrypt personally identifying information
This API product converts a customer’s mobile telephone number (MSISDN) into the secure tokenised Anonymised Mobile Subscriber Reference (AMSR) and vice versa.
This API product retrieves the level of content lock for a given account from 3 security levels.
Data pass eligibility
Retrieves all data passes that this customer is eligible for, and presents them in a list.
Foreign Visitor API
Provides volumes for the overall footfall of foreign visitors to the UK by country of origin, foreign visitors footfall locations, foreign visitors footfall based on their activity on the first day of arrival and foreign visitors footfall based on their…
This API product retrieves the mobile brand of a subscriber, to determine whether they are registered with EE, BT or with a mobile virtual network operator partner (MVNO).
The Messaging API enables a developer to send a single text message (SMS) to EE mobile customers.
API product can check whether monetary charge can be applied onto a customer’s EE PAYM/PAYG mobile account. This should be used prior to using the Charge API.
Order Notification Import Orders (Ethernet)
Automated notifications on progress of orders placed via the Import Order APIs will be sent directly to the provided URL ('callback URL') provided at onboarding.
Product Order (Ethernet)
Place, modify and track Ethernet orders across Etherway Fibre (EAD), Etherflow Connected, Etherflow Internet and Etherway Superfast GEA (SOGEA & FTTP).
Back to top