Getting started with our APIs

1.

Explore our APIs

Start with our API Explorer to browse our catalogue of APIs. Find out about features and benefits and view developer communication.

2.

Register for API access

We use Mulesoft's Anypoint platform to develop and expose our APIs. To use the RAML you need to register and get login access to our portal.

3.

Accept Terms and Conditions

Please remember to read our Terms & Conditions for APIs to ensure there are no surprises when you use our APIs.

4.

Build and test in Sandbox

Once you have decided which APIs you want to include in your application, you can request Client Credentials. This will let you test your application using our test data.

5.

Request access for production

After testing your application and you are ready to launch you must register your application with us; apply for access to API Production

Line Test API

The Line Test API is a diagnostic test tool for Service Providers that delivers visibility of your Chorus broadband services.  Build your application with this API and you will get real-time diagnostic capability that can be seamlessly integrated with your internal support systems and operational processes. Achieve faster resolution times and an even better customer experience with this capability at your fingertips.

The Line Test API for fibre provides full access to our NGA fibre test suite, providing the same capability as Check Mate, while giving you flexibility over how you deploy it.  Get information about your NGA services, historical and current ONT status and snapshots of traffic passing through the UNI, which can be integrated directly with your Assure processes, scripts and systems.

The Line Test API for copper provides a subset of the tests available through our eSPM portal, providing real-time status information of each broadband connection.