This guide is currently in draft status and should be considered incomplete.
Welcome to Nitrogen!
About Nitrogen#
Nitorgen is Aussie Broaband's in house wholesale platform, designed to be a seamless API experience for partner tenants.
Nitorgen is an API-first platform. Wholesale partners are required to integrate with the API in order to use Nitrogen.
A limited API administration portal is available for wholesale partners - this primarily allows your technical integration teams to manage your integration with the API and callback subscription service. It does not provide a user interface for the API functions of the platform.
The rich API gives wholesale partners the ultimate flexibility to build their own portals and UIs for their users and customers by integrating with the Nitrogen API.
Nitrogen API Information#
The API is an asynchronous REST API.
Whilst it is possible to poll the API for updates to resources, virtually all events for a resource are available via callback notifications which wholesale partners can subscribe to.
Tenants are strongly encouraged to utilise the callback notifications that Nitrogen provides as opposed to polling the API for updates. Tenants can manage their subscriptions to the callback notifications via the tenant portal.
Wholesale Partner User Guide#
This user guide is a key resource which should help your teams to integrate with the Nitrogen API. It focuses on some of the key concepts, processes and workflows that will assist you to interact with the API, and supplements the Open API specification.