API Requests

Security

A valid and unexpired access token is required to access the service.

See Authentication for information on how to get a token.

To authenticate send the token in a Authorization: Bearer IDP_ACCESS_TOKEN header, for example

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJYMWxrOURXQ1pSYjlpbkxxSlZnMERGRDRrblBOX25mWVlKOUVFV3c2QWhzIn0.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.UYv5sdrUNFq1TOl2Ogr8BhWv9sHABKLVFMfJakNSZtb2ZmBpEsal0WBgALfNYDT8Owez6hzENACt-AOULFzb8s9HDkEs5WaWTkKgVSyuYi0mMtPqAN0-pkcByinyPwpoOqKBMQlXNHA3xtYGIUdyaxOwotxNMNQ44TiEfUO_ujHdjfnzIAcNABEXqU7YR6-3QIS37onw5pUpLfkiwYVvIcggomubV903tOh0SZo4EGtRlf-k7IaVBhkBM5EnA7AH2atF_ixzj03xAbs4GO4wBLekwnyEMwG1qmZlVAkh9kwgW9uHXYdPI1GmmQzgLy6cpKnRBLvX86-GbOrpgmEtiQ

Endpoints

Primary Endpoint

The primary endpoint /public/api/v1 is designed to receive an authenticated POST request with a XML encoded ApiRequest description.

Transferred response bytes are included in the calculation of the usage quota.

ApiRequest

ApiRequest Element

Secondary Endpoints

Secondary endpoints are used in the ApiResponse of the primary endpoint to reference additional resources.

Images

Images are referenced using URIs with a path starting with /public/api/v1/resources/img/.

The client can fetch the image with an authenticated GET request. Image formats include PNG, JPEG and TIFF. Check the Content-Type response header for the concrete format.

Transferred response bytes are included in the calculation of the usage quota.

Tip

Images are content-addressed, meaning that the URI corresponds directly to the image’s content. As a result, once you have downloaded the image and the URI remains unchanged, you won’t need to download it again. This approach helps conserve bandwidth and reduce quota consumption.

Documents

Documents are referenced using URIs with a path starting with /public/api/v1/resources/doc/.

The client can fetch the document with an authenticated GET request. Document formats include PDF and TXT. Check the Content-Type response header for the concrete format.

Transferred response bytes are included in the calculation of the usage quota.

Warning

Documents are not content-addressed (yet). As a result, the same URI can yield different results over time.