This API will replace the current file-based deliverables of book metadata to DBK and Bogportalen.
1. Overview
Purpose: Integration to send product metadata to Bogportalen.
Base URL (Production): TBA
Base URL (Sandbox): TBA
Formats: xml in onix format; charset=utf-8 (requests & responses). See Onix format for data to DBK here.
2) Authentication & Authorization
Auth method: User name + password
mTLS (optional/high-security clients): Supported
Headers
- Idempotency-Key: <uuid> (required on POST/GET with side-effects)
3) Versioning & Lifecycle
Onix version: Onix 3.X
API URI versioning: /v1/…
Deprecation policy: 6 months minimum notice before removing fields/endpoints.
Change types:
- Non-breaking: new fields (nullable), new endpoints.
- Breaking: contract changes; only in new major version.
4) Environments & Data
Sandbox: Synthetic data; standalone auth, same functionality as production.
Production: Live data; standalone auth, same functionality as sandbox.
5) Pagination, Filtering, Sorting
Pagination: n/a
Filtering: n/a
Sorting: n/a
#products: 2.000 / request (it’s strongly advised to make this parameter configurable, as it might change!)
6) Status codes and errors
Status codes:
- 2xx success
- 4xx client error
- 5xx server error
The list of error codes will be further extended when the sandbox version of the API is ready.
Error body:
{
"error": {
"code": "invalid_parameter",
"message": "Unknown filter 'foo'.",
"details": [{"field": "foo", "issue": "unsupported"}]
},
"correlation_id": "b9c3e7c0-…"7) Caching & Performance
ETags/If-None-Match: Supported on GET for cache validation.
Compression: gzip & br supported via Accept-Encoding.
8) Security
Transport: HTTPS only (TLS 1.2+).
Auditing: We log auth, rate-limit, and error events with correlation IDs.
9) SLs & Status
Uptime target: 99.9% monthly.
Maintenance windows: Announced 7 days ahead (non-critical).
Status page: Public status + historical incidents. · Support: FAQ/Support page on dbk.dk. Email + ticketing portal, business hours CET/CEST.