Authentication

Authentication of users to the API is done via OAuth 2.0 endpoints with bearer tokens. For more information, see also:

Authentication of custom applications to the the API is done through Application Keys and Application Secrets, which are uniquely generated for each application, and bound to the account that created them.

Getting started

Getting your own applications to talk to Proxy is easy!

Get your Application Key and Secret

To get your hands on credentials you will first need to create an application within your account. Follow the steps and you will be provided with the credentials you need to authenticate your application with us.

notice-information In all of the code examples below, please replace `{App-Key}` with your Application Key and `{App-Secret}` with your Application Secret.

notice-error Keep your Application Secret protected! It is the equivalent of a full administrator account, and has unrestricted access to all Proxy resources within your organization.

Examples

Authenticate to the API

Below we use our Application Key and Secret to fetch all organizations within your application's scope at Proxy. The authorization method used is HTTP Basic Auth, with your Application Key acting as the username and Application Secret as the password.

Fetch all the organizations for your application:

1
2
3
4
curl -X GET \
    https://api.proxy.com/v1/orgs \
    -u '{App-Key}:{App-Secret}' \
    -H 'Accept: application/json'

The API responds with the list of all organizations attached to this application:

1
2
3
4
5
6
7
8
9
10
{
    "items": [
        {
            "id": "e222648c-48bb-4dbe-9d46-7c2484fad1bd",
            "name": {
                "formatted": "My First Org"
            }
        }
    ]
}