Versioning
The major version is in the path (/v1). The exact version is in every response in the Garanify-Api-Version header, currently 1.0.0.
The API is built and tested. Hosting at api.garanify.com is in preparation; until then it runs locally. Keys are available on request.
What may change in v1
These changes come without notice. Your client should ignore unknown fields and values:
- new endpoints
- new optional fields in requests
- new fields in responses
- new error codes and new enum values in responses
- new headers
- different texts in title and detail
What only comes with a new major version
- removing or renaming fields or endpoints
- new required fields in requests
- changing the type or meaning of a field
- stricter validation of existing fields
- changing key formats or authentication
A new major version gets a new path (/v2). /v1 keeps running for at least 12 months after that.
Deprecation
We announce deprecated endpoints or fields at least 12 months in advance: in the changelog, by email to account owners and in every affected response with the Deprecation (RFC 9745) and Sunset (RFC 8594) headers. We never switch off legally required displays without a replacement.
HTTP/1.1 200 OK
Garanify-Api-Version: 1.4.0
Deprecation: @1798761600
Sunset: Thu, 31 Dec 2027 23:59:59 GMT
Link: <https://garanify.com/en/developers/versioning/>; rel="deprecation" Changelog
Every change with its date is in the API changelog.
Changes to the plugins and the website are in the main changelog. The specification: openapi.yaml, errors in errors and codes.