Authentication

Blue API (BETA) authentication is now available here. Check it out.

Authentication for Wave (OpenAPI) is separated at the moment. We will be unifying all logins for all our APIs going forward. An announcement will be made once it's done.

Before you can access Alphaus API services, you need to get an access token first. You will then use this token in your succeeding calls to the API using the Authorization: Bearer {token} HTTP header. Alphaus API tokens are JSON Web Tokens (JWT).

Use the following endpoints to acquire product-specific access tokens. Tokens are not compatible between the two. Ripple access tokens can only be used for Ripple endpoints; Wave access tokens are only valid on Wave endpoints.

# Ripple
https://login.alphaus.cloud/ripple/access_token

# Wave
https://login.alphaus.cloud/access_token

Request

To obtain an access token, send a POST message to the access token endpoint using the format described below.

POST {access-token-url} HTTP1.1
Content-Type: multipart/form-data

{body formdata}

The following table describes the formdata you need to supply as your POST body.

Name	Value
grant_type	Valid values: password, client_credentials
client_id	The client id you received from Alphaus or from API.
client_secret	The client secret you received from Alphaus or from API.
username	You account username. Required if grant_type is set to password.
password	You account password. Required if grant_type is set to password.
scope	Valid values: openid

Response

HTTP/1.1 200 OK

{
  "id_token": "eyJ0eXAiOiJKV1Q...",
  "token_type": "Bearer",
  "expires_in": 86400,
  "access_token": "eyJ0eXAiOiJKV1Q...",
  "refresh_token": "def50200..."
}

Using bluectl

You can also use our bluectl CLI tool to generate access tokens. It is designed to work with the client_credentials grant type, although it supports the password grant type as well. To set the required environment variables for authentication, check out this document.

# Simple version:
$ bluectl access-token

# You can also access our beta (next) environment:
$ bluectl access-token --beta

# Use with other commands (example):
$ curl -H "Authorization: Bearer $(bluectl access-token)" \
  https://some-ripple-endpoint/...