Introduction

A quick introduction to our REST APIs and how to get started using it.

Overview

Our REST APIs can be used to interact with our services programmatically. Our own web application is using the same APIs as documented here.

First steps

The only thing you need to get started using our REST APIs is a Service Account with sufficient permissions for the task you want to do. While subsequent Service Accounts can be managed through the REST API itself, an initial service account must be set up using the web application as an entry point.

Start using our REST API

After Creating service accounts, you may proceed to viewing the full API reference to explore which API endpoints are available.

Authentication

Our REST API supports two methods of authentication, both using a Service Account for access control.

• Basic Auth: Simple username and password authentication; for quick prototyping.

• OAuth2: A robust exchange of credentials for an access token used to authenticate.

We strongly recommend using the OAuth2 authentication flow when integrating with our REST API and to use Basic Auth for quick experimentation and exploration of our APIs.

Head over to our Authentication section to get started.