Skip to main content

Specifications Introduction

Welcome to the API Specifications page. In these pages one will find detailed specifications per API.

Testing APIs​

The documentation UI supports testing the APIs directly in your browser.

  1. Use the token endpoint to retrieve your access token

    • Enter your client_id
    • Enter your client_secret
    • Select grant_type = client_credentials
    • Click on Send api request
    • Copy the token from the response

  2. Select the API endpoint that you want to use from the sidebar and paste the token in the bearer section

    • Example: Ingest API status endpoint
    • Select Security Scheme = OAuth2Client Credentials (if needed, depends on API)
    • Paste the token from step in the Bearer token text box
    • Click on Send api request to use the API

Generating Clients​

Our REST documentation pages supports generating clients in multiple programming languages. Follow the example the steps above to test an endpoint and you will be able to copy client code for different languages with your values and URLs.