Getting started

Consuming a service

All of our APIs are Restful JSON APIs using the HTTP protocol. We follow the JSON API specification for formatting requests and responses. You can call the APIs using any HTTP client, for example curl, the HTTP module in Node.js, or the Python requests package.

Each service returns the service uptime, current server time and API version on the root URL. Try the following command in your terminal to see it in action:

curl https://api.ultimaker.com/cura/v1

This will return the following JSON response:

{
    "uptime": 621817.742952,
    "time": "2018-04-17 20:06:45",
    "version": "1.0.0"
}

Authentication

To call an API endpoint that is protected using OAuth2, you must send along the access token in the HTTP header as Bearer token:

curl --header "Authorization: Bearer YOUR_ACCESS_TOKEN" https://api.ultimaker.com/cura/v1/jobs

More details about our OAuth2 implementation can be found in the Authentication section.