Welcome to ChargeAfter API! This document provides guidelines for understanding and adapting to changes introduced in our API. We strive to keep you informed about improvements, additions, and any breaking changes to ensure a smooth integration experience.
Types of Changes
Non-Breaking Changes
Non-breaking changes include updates that enhance functionality, improve performance, or add features without disrupting existing integrations. Developers can seamlessly adopt these changes without making modifications to their code.
Examples
- Addition of a response body when one didn’t previously exits
- Re-Ordering of fields in the JSON
- Addition of new values to an enum if default is defined
- Addition of optional or read-only fields and properties
Breaking Changes
Breaking changes are modifications that may affect existing functionality or require adjustments in client applications. These changes are necessary for evolving the API and may include endpoint deprecations, changes in data structures, or alterations to authentication methods.
Communication
Release Notes
Regularly check our release notes for details on upcoming changes. We provide comprehensive information about each release, including a summary of non-breaking and breaking changes, new features, and improvements.
Deprecated Features
If a breaking change involves deprecating certain features or endpoints, we clearly communicate this in our documentation and release notes. We specify deprecation timelines and provide alternatives whenever possible.
Communication Channels
Subscribe to our mailing lists, through our account managers, or our news page, to stay informed about changes. We use these channels to announce releases, share updates, and address user queries.
Adapting to Changes
Versioning
Understand the versioning system of our API. Breaking changes are typically introduced in new major versions. Ensure your applications are compatible with the latest version to access new features and improvements.
Testing
Before deploying updates to your production environment, thoroughly test your application against the latest API version in a controlled environment. This helps identify and address any potential issues before they impact end-users.
Timely Adoption
While we provide details about upcoming changes, we encourage timely adoption of new API versions to benefit from the latest features and improvements. Delaying updates may lead to compatibility issues.
Support
If you encounter challenges during the adaptation process or have questions about the changes, our support team is here to assist you. Reach out through our designated support channels for prompt assistance.
Conclusion
By following these guidelines, you can navigate changes to ChargeAfter API smoothly. We appreciate your commitment to staying informed and adapting to the evolving landscape of our API.
Thank you for choosing ChargeAfter API !