Versioning

The developer API is served at https://api.epostix.com/v1. Keep the /v1 prefix in the base URL. Official SDKs include it by default.

Tolerate additions

An integration should tolerate new endpoints, optional fields, response headers and values in open-ended fields such as status, event type and error type.

Ignore response fields you do not use. When branching on a status or error type, keep a fallback for values your application has not seen. An unfamiliar value should not crash a webhook handler or make it report success by default.

SDK versions

SDK package versions are separate from the API path version. Pin dependencies through your normal lockfile or module configuration, review release changes, and test before upgrading.

The SDK guide links to each library's source and releases.

The contract

The OpenAPI document describes the API's endpoints and schemas. The reference is generated from that contract.

You can generate a client or import the document into an HTTP tool. Generated code still needs appropriate error handling, pagination and retry behavior; a schema alone does not supply those policies.