API Setup¶

This functionality is in Beta state

The API Module provides a REST-Style access to some of the Cloud functionality, and is only accessible if your organisation has subscribed to the service.

Your user Roles after login in the https://live.hyprint.de interface should display the organisation:api role. If not, please contact your account manager.

Token Creation¶

Once you have access to the API module, you will see a User > API menu in the web ui.:

In the following page, you can create new tokens and delete old ones.

To create a token, just click on the Add Token button, and follow the instructions on the next Dialog:

The created Token is a JWT token, which you can parse to see it's properties using a tool like http://jwt.io.

Since thhe Token is a rather long text string, you can opt to download it as a Header file which can then be loaded from the command line by a tool like curl, using the -H @file syntax.

Request Setup¶

All the calls to the API must be protected by providing the JWT token to the request using the Bearer Authorization mechanism, by adding following headers to your request:

• Authorization: Bearer TOKEN
• X-HYPRINT-IDP: urn:de:hyprint:access:idp:2021

The main API Endpoint is located at https://access.hyprint.de/api/app/ext/v1

To test your token, you can use the "ping/pong" service which returns some simple data like your user ID, organisation ID and version of the cloud software:

$ curl -H@hyprint_api_TOKENID.headers https://access.hyprint.de/api/app/ext/v1/ping

The response should be similar to this example:

{
    "status":"OK",
    "code":200
    "content":{
         "pong":1619550766085, // TIMESTAMP on Server Side
         "build":"SOFTWARE_VERSION",
         "user":"USER_ID",
         "organisation":"ORG_ID"
    },

}

If the Token setup was wrong you would get an HTTP Error 401 (unauthorized).

Rate Limiting¶

As this module is in beta-testing, all the requests must be followed by a wait time grace period of 3 seconds.

Any request within a 3 seconds window of a previous call will return a HTTP 429 (Too Many Requests) - The Rate Limiting headers are not returned at the moment, but will be in the next updates.