Skip to main content

Portal API

Portal API is a RESTful API giving developers possibilities to automate frequent tasks around:

  • Environments creation
  • Product activation (e.g., Axinom DRM)
  • Usage reporting

Access

To access the API, you need an API token.

Currently, you can request your API token via a support request.

You have to supply this token as a bearer-token within the Authorization-header.

API Documentation

Here’s the link to the Open API endpoint:

Axinom Portal Public API (OAS 3.0 Swagger)

Examples

To retrieve a list of environments:

GET /env

To create a new environment:

POST /env

{ "name": "string", "template": "DEV" }

To create a DRM configuration for a new environment:

POST /env/{id}/services/drm

note

Make sure to store the response securely - you will need the generated management keys and you will not be able to retrieve them again.

To retrieve DRM service consumption for the previous month:

POST /env/{id}/services/drm/reports/billing

{ "year": 2025, "month": 2 }

Questions or suggestions?

Ask Support