API essentials

Request client credentials

The Client ID and Client Secret are unique to each of the API Sandbox and Production environments. 

Sandbox: Once you have applied for, and received credentials, Chorus will perform a minor configuration change. When this is completed, you will be notified from the Anypoint Platform that your application is approved. This registers your application.

Production: The process for API Production access is similar to Sandbox access, except your API application name must be different than your Sandbox application name so you can receive a unique credential for your application. 

Tip: For Sandbox and Production API access, you can connect to any number of APIs re-using the same application name, Client ID and Client Secret. However if you prefer to individually name each application to associate it with the API, you can do this instead.

 

Apply for access to the API Sandbox

Go to the Sandbox developer portal for the API you want to access:

  1. ClickRequest buttonat the top of the screen.
  2. From the Request access dialog, in the API Instance field, select PRD-SANDBOX.
  3. Either select your application from the Application list, or select Create a new application and complete the Create a new application dialog. Note: You cannot use the same client application for Sandbox and Production. A new application must be created for Production use. If you are creating a new application, name your application using: <organisation name>–<name of application>–<API instance, Sandbox/Prod>
  4. Select an SLA Tier.
  5. Read the Terms and Conditions and tick I accept to proceed.
  6. Click Request API access to submit the request form. You will be notified via email when your request status changes.

If you cannot see a Sandbox environment in the Anypoint Platform, go to the API Support page and submit a request. We’ll get back to you with further instructions. 

 

Apply for access to Production

You must register your application with each Chorus API that the application uses:

  1. In the Production API developer portal,clickRequest button. Do this for each API your application uses.
  2. From the Request access dialog, in the API Instance field, select PRD
  3. Select your application from the Application list. You can manage your applications via https://anypoint.mulesoft.com/exchange/applications/ Note: You cannot use the same client application for Sandbox and Production. A new application must be created for Production use. If you are creating a new application, name your application using: <organisation name>–<name of application>–<API instance, Sandbox/Prod>
  4. Read the Terms and Conditions and tick I accept to proceed.
  5. ClickRequest API accessto submit the request form.
  6. Repeat these steps for each API your application uses.
  7. You will be notified via email when your request status changes.

Please test and advise API Support if you have any issues.

When you register your application for the Line Test API, the responses we provide will be assigned to the registered organisation name. If you own broadband lines that were previously owned under different organisation names, you must complete an application for each of those old organisational names to ensure you retrieve the correct data on those lines. We are aware of this limitation and are working to resolve it. Thank you for your patience.

 

Reset Client Secret

If your Client Secret is lost, forgotten or has been compromised…

Then

after you have registered the application and you are not the application owner,

contact your application owners to reset this for you.

after you have registered your application and you are an application owner

(each application must have at least two),

go to Anypoint > My Applications and reset it.

before you have registered your application,

contact API Support.