API Versioning
The API is versioned using the URL path. The current version is v2 (e.g., /v2/document, /v2/search).
Versioning policy:
-
No breaking changes are introduced within the same API version.
-
If a breaking change is required, a new version is released (e.g.,
/v3/), while the previous version remains available and supported.
We follow a quarterly release cycle, and API documentation is maintained per release so you always have a clear reference for the version you're working with.
Base URL
The base URL for the API is environment-specific and provided per customer during onboarding. Both the Ingest and Dissemination APIs are accessible through the same base URL, with versioned paths (e.g., /v2/document, /v2/search).
The Keycloak (OpenID Connect) token endpoint URL is also environment-specific and provided during onboarding. See Authentication for details on obtaining a bearer token.
Rate Limits
Rate limiting is set to 500 requests per 5 minutes per IP address.
If a higher throughput is needed, this limit can be increased. Please contact us with the expected volume and we can adjust accordingly.