Product Offering API
Testing
Chorus NZ is committed to making integration with our APIs easy and robust and we are available to provide support for your development and testing.
For information on access and setup requirements for our emulation environment (EMMA) for testing the Fibre APIs, see Emulation Environment (EMMA).
On this page, you will find information on suggested test cases and test data.
Test cases
As with any software development, Chorus encourages you to test your application with both positive and negative scenarios. The test cases we've provided here are for your convenience, but are not intended to be comprehensive.
Some test cases may not apply to your use of the API. Please extend these cases with test cases that are specific to your business and use cases.
Comprehensive testing of your application should also include:
- API response time
- high traffic
- different types of requests
- different types of data
- handling errors and exceptions.
The following suggested test cases are designed to assist you with searching the product catalogue and retrieving information about product offers for an address or location, as part of initiating a fibre order.
Note: These test cases all use UFB Product Offer Zone.
| ID | Test case | Expected result |
|---|---|---|
| FPO1 | Submit a GET product offers by query search to retrieve all available product offers at an address/location. | The API will return a 200 response code and all product offers available at the address/location. |
| FPO2 | Submit a GET product offers by query search to retrieve all available product offers at an address/location filtered by market segment: Residential. | The API will return a 200 response code and all Residential product offers available at the address/location. |
| FPO3 | Submit a GET product offers by query search to retrieve all available product offers at an address/location filtered by market segment: Business. | The API will return a 200 response code and all Business product offers available at the address/location. |
| FPO4 | Submit a GET product offers by query search to retrieve all available product offers at an address/location filtered by market segment: Education. | The API will return a 200 response code and all Education product offers available at the address/location. |
| FPO5 | Submit a GET product offers by query search to retrieve all available product offers at an address/location filtered by product offer type. | The API will return a 200 response code and all Primary or Secondary product offers available at the address/location. |
| FPO6 | Submit a GET product offers by query search to retrieve all available product offers at an address/location filtered by Product Family Name: PONFAS Distribution. | The API will return a 200 response code and all product offers available at the address/location. |
For sample error messages, see the API Specification.
Learn more about our error codes.
Test data
Postman collection
We have provided a Postman collection file to make it easy to test this API, which includes examples of requests that will generate responses within the EMMA environment. This includes successful responses and error codes.
Note: You will also require your Azure Client ID and Client Secret to obtain a token as part of the global variables. To request access, contact API Support.
The following scenarios are intended as a guide and for use with the variable names and values, which must be set prior to running the Postman collection.
| Test Case | Place ID | Product Family | Segment | Offer Type |
|---|---|---|---|---|
| FPO1 | Mandatory | Bitstream | Residential or Business or Education | Primary or Secondary |
| FPO2 | Mandatory | Bitstream | Residential | Primary or Secondary |
| FPO3 | Mandatory | Bitstream | Business | Primary or Secondary |
| FPO4 | Mandatory | Bitstream | Education | Primary or Secondary |
| FPO5 | Mandatory | Bitstream | Any | Primary or Secondary |
| FPO6 | Mandatory | PONFAS Distribution | Residential or Business | Primary |
If you have any questions about your test data needs or need to request access, contact API Support for assistance.