Which changes Aera makes without a new version, and which ones get a new version.
Master: api-docs.aerahost.comWe're moving our API docs to docs.aera.id. Until the move is done, 2.2.2. Breaking vs. non-breaking changes on api-docs.aerahost.com is the master for this page. If this page and api-docs differ, api-docs is right.
Changes without a new version
Aera adds to its APIs without warning. Make your integration accept:
- new fields in responses
- new nested objects
- new endpoints
Ignore fields you don't know. Don't fail on them.
Changes that get a new version
These would break integrations, so Aera releases them as a new version:
- renaming a field or a path
- removing a field, even an optional one
- changing a single value into a list
- changing the HTTP method or response code of an endpoint
You keep using the old version until you move to the new one. Sometimes Aera and the users of an API agree on a temporary change that stays backward compatible instead.
Where the version is
| API | Version |
|---|---|
| Online payments | In the Accept header: application/vnd.payments.v1+json |
| Reporting API | In the path, for example /api/reporting/v2/... |
New versions and changes are announced in the Changelog.