Authentication

Accessing resources exposed through the API requires explicit authentication.

All requests must include an Authorization header in order to perform HTTP basic access authentication using an existing username and password as credentials.

GET /api/v1 HTTP/1.1
Host: account.emailicious.com
Authorization: Basic Zm9vOmJhcg==

Failing to provide valid credentials will result in an 401 Unauthorized response.

HTTP/1.1 401 UNAUTHORIZED
Content-Type: application/json
WWW-Authenticate: Basic realm="api"

{
    "detail": "Invalid username/password."
}

Note

Emailicious usernames contain the “@” character which is also used as the credential and host separator of an URI. Most HTTP clients make sure to percent-encode the username and password part but you might have to replace this character by %40 if it’s not the case.

For example, the cURL command line tool requires manual replacement:

curl https://user%40domain.com:password@account.emailicious.com/api/v1