Skip to main content

API Upgrades

Kaunt uses API version codes to manage non-backwards compatible changes. All API endpoints contain a version code, e.g., /v1/, which indicates the version of the corresponding API endpoint.

Customers are notified about non-backwards compatible changes several months ahead of the update. The old versions will usually be supported for a defined period after the release of a new version, typically at least 6 months.

By far, most updates to the API are backwards compatible. This means that they should not break behavior in existing applications. Kaunt considers the following changes to be non-breaking:

  • Addition of new API endpoints
  • Addition of fields to API responses
  • Addition of optional fields in API requests
  • New optional URL parameters
  • Updates to human-readable texts such as error messages
  • Addition of new webhook event types

Documentation and Testing​

Comprehensive documentation is available for each API version, including detailed descriptions of endpoints, request and response formats, and examples. We recommend users to thoroughly test their integrations against new API versions in a staging environment before deploying to production.

Best Practices for Future-Proof Use​

To ensure your applications remain compatible with future API versions, consider the following best practices:

  • Use Versioned Endpoints: Always use the versioned endpoint URLs (e.g., /v1/) to avoid unexpected breaking changes.
  • Handle Additional Fields Gracefully: When parsing API responses, ensure your application can handle additional fields without breaking.
  • Utilize Optional Parameters: Make use of optional fields and parameters where applicable, but ensure your application can function without them.
  • Monitor Deprecation Notices: Keep an eye on deprecation notices and plan to update your integrations before the deprecated features are removed.
  • Implement Error Handling: Implement robust error handling to manage unexpected changes or downtime gracefully.
  • Manage Webhooks Effectively:
    • Ensure your webhook endpoints can handle new and unexpected event types gracefully.
    • Validate webhook payloads to ensure they come from Kaunt.
    • Log webhook events for debugging and auditing purposes.