/
API V2 Email draft

API V2 Email draft

 

Dear Client,

We are excited to announce the upcoming release of the Maxxton REST API Version 2. Over the past few months, our team has been diligently working to enhance the current API with several key improvements aimed at:

  • Enhancing Clarity: Providing clearer and more comprehensive information.

  • Ensuring Consistency: Standardizing terminologies across all endpoints and within the MXTS system.

  • Extending features: Adding and removing certain fields and adding more features

  • Streamlined development portal: one place containing all the information to integrate with Maxxton

However, the release of API Version 2 will also require seamless integration with third-party APIs. Therefore, it is essential to verify whether these changes necessitate any actions from third-party partners.

To ensure a smooth transition, we have created comprehensive documentation and a migration guide for our third-party partners to migrate from version 1 to version 2. In case of any questions or doubts please reach out to our API support team. They are ready to help you.

As a part of the release of version 2, we decided to start phasing out our version 1 API and SOAP web services. We want to inform you that if any of your SOAP Webservice users choose to migrate to the REST API, they will be directly transitioned to API Version 2. There will be a timespan of 6 months to make the changes and migrate to the new version 2 REST API. After this, version 1 REST API and SOAP web services will be closed and no longer operational.

Schedule

Action item

Due date

Action item

Due date

Release of API version 2 on test environment

 

Release of API version 2 on the production environment

 

Third-party migration time window

6 months

Phase out REST API version 1

 

Phase out SOAP web services

 

Your cooperation and timely action are essential to ensuring the success of the release.

Thank you for your attention and support.