Getting started

Welcome to the BT developer portal. This guide outlines the end-to-end journey for integrating with our APIs, from initial exploration to launching your application in the production environment.

The process follows four main steps. Each step has links to detailed guides and resources to help you succeed.

Step 1: Explore our Products and APIs

First, familiarise yourself with what our Products and APIs can do. We provide several resources to help you understand their capabilities:

  • Products: This section details our popular APIs and shows how they can be used in real-life scenarios.
  • Documentation: Here you will find detailed technical descriptions, endpoint references, and downloadable specifications (e.g., for Postman) for each API.

Read a more detailed developer portal walkthrough

Step 2: Register and set up your sandbox

To begin development, you need to register for an account and create a sandbox application. This will give you the test credentials needed to make your first API calls.

Follow our step-by-step guides to get set up:

Step 3: Develop and test your application

With your sandbox app created, you can now use its Client ID and Client Secret to authenticate and start making calls to the API.

Our sandbox environment allows you to test your integration against a variety of key success and failure scenarios, which are detailed in the API documentation.

Step 4: Go live with Production access

Before you can use our APIs with live data, you'll need to agree to our contractual terms.

  1. Contact your account manager or use the Contact Us form to start the process.
     
  2. Once your contract is in place, you can create Production apps in your Dashboard.
     

Getting help

  • Have questions?  Explore our Knowledge Centre:
  • Unfamiliar with a term? Our glossary defines the key technical terms and acronyms used across the developer portal.
  • Haven't found a solution? If you need to contact our support team, use the contact form.
Back to top