Overview

Conventions

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Furthermore this API follows the specifications of the JSON:API.

Versioning

Paths include major version (e.g. v1, v2) and each request requires the Warrify-Version header for non-breaking versioning.

Optional Fields

In general you SHOULD omit an optional field from a request instead of sending an empty string or null.

Headers

Mind that some requests require some HTTP Headers to be set. Especially Accept and Content-Type for content negotiation. If they are omitted or contain invalid values the request will be rejected.

Sandbox Environment

During development and testing the production environment can be used. However a separate Tenant is required.