Transition to this REST API
If you are a user coming from our old non-REST API then we recommend reading this guide as a first step.
Why Are We Making This Transition?
Our new REST API offers several key benefits:
- Improved Performance: REST APIs are optimized for faster, more efficient interactions, reducing latency and improving the overall speed of our services.
- Enhanced Flexibility: With the new RESTful structure, developers will find it easier to integrate, customize, and expand functionalities as needed. The REST architecture allows for better modularity and a more intuitive approach to resource management.
- Scalability and Reliability: The REST API is designed to support high volumes of traffic and data, ensuring a more stable and scalable solution as your business grows.
- Enhanced Security: Built-in security protocols within REST ensures that your data remains protected while maintaining easy access to authorized users.
- Consistent and Standardized: As REST has become an industry standard, it offers a consistent experience across platforms, improving development efficiency and compatibility.
What Does This Mean for You?
Our team has been working hard to ensure this transition is as seamless as possible. You can expect:
- Continued Support: During the transition period, both the old API and the new REST API will run concurrently, allowing you ample time to switch over with minimal disruption.
- Updated Documentation: We’ve prepared a comprehensive guide to help you understand how to use the new REST API. This includes detailed examples, use cases, and step-by-step instructions for migrating from the previous API.
- Developer Support: Our support team is available to assist your development team throughout the transition. If you encounter any issues or have any questions, don’t hesitate to reach out to us.
Next Steps
- Review the Documentation: You can find our updated API documentation here in this portal hub. We recommend that you familiarize yourself with the new REST API as soon as possible.
- Plan the Migration: Begin planning your transition to the REST API. Our team is available to guide you through the process.
- Update Your Integration: You’ll need to update your systems to interact with the new API endpoints. Our developer support team is available to assist you with this transition.
We understand that changes to critical systems can sometimes be daunting, but we’re confident that this move to a fully RESTful API will bring significant improvements to the speed, reliability, and flexibility of our services.
Thank you for your continued partnership. We look forward to supporting you during this transition and are excited about the opportunities this will unlock for your business.
Mapping from Non-REST to new REST API
Here is a link to an excel-file to see the fieldnames between the two apis.
Updated 22 days ago