Upcoming change to API specification (OAS) access URLs – effective September 24th

Due to an internal software update by the third-party provider we use to publicly publish our APIs, the way customers access the Open API specification (OAS) files will change slightly. The URL used to retrieve each of the specification files will be updated — transitioning from a purely technical identifier to a human-readable identifier and file name. The structure and content of the specification files remain unchanged.

The entry point for all OAS files remains unchanged as well at https://docs.nitrobox.io/v2/reference/openapi-specification-oas.

Please ensure that any integrations or tools relying on the previous URLs are updated accordingly for continued access and processing of these files. This change will take effect on Wednesday, 24th of September.

For your convenience, we have listed the mapping of changes for each API below:

former idreadable name
60b8f92103850600379a144ccustomer-api.json
60b8f92afaffeb00384d100dtax-api.json
60b8f931b43816001cd4445ebookkeeping-api.json
60b8f931b43816001cd6666fdata-access-api.json
60b8f931b43816001cdaaabbinvoice-api.json
60b8fd22f29bb1003435102bbilling-api.json
60b8fd22f29bb1003435122apayment-api.json
60c228fbd9965900163981c1booking-engine-api.json
627901a64eb9690074d188f0document-output-api.json
62d53b9c72c9ef0034faeaf8notification-api.json
6544c9a3f649360d0d3d6044report-api.json
65a66a592a3e9b00419e05e1usage-api.json
66826ea22f18d1006b52d89apayment-assignment-api.json
682dc3259dca6f0030e2c751currency-converter-api.json

Example

https://docs.nitrobox.io/v2/openapi/60b8f92103850600379a144c

will change to

https://docs.nitrobox.io/v2/openapi/customer-api.json