We are dedicated to improving our suite of APIs, which means we will periodically make updates to enhance your experience with our services by offering improved products and services, stability, and reliability. Our API versioning policy aims to ensure changes are made consistently and give you the flexibility to adopt them with greater ease. 

In preparing the policy we have included commonly understood API software practices, learnings from recent years, and sought input from the participants in the Fibre API co-design forum earlier in 2023. 

The purpose of this consultation is to seek feedback on this refreshed API Versioning policy from all our API users (RSPs, Service Companies and other organisations) to ensure that the policy employs modern software change practices and is fair and reasonable. The best people in your organisation to review and provide any feedback are those: 

• Experienced in working with RESTful APIs  
• Performing a role like one of the below:  
  • Senior Architect  
  • Lead developer   
  • Technical lead  
  • QA Tester  
  • Change Manager  
  • Programme or Project Leads 

The versioning policy and consult pack can also be found at the bottom of this page. If you would like to provide feedback, please complete the feedback form before close of business on 3 November 2023.

Contact

If you have any questions about this consultation, please contact your account team.