Authentication

Before you can request data via a REST call you need to have an authentication token. To get this token you can use one of the tools described on this page.

URL

/api/v1/login

Method

POST

URL parameters

None

Header Parameters
Parameter Type Required Description
Content-Type String Yes Provide the content type of your call. Only application/json is supported.
Body

The body is a JSON object that consists of two fields

Parameter Type Required Description
username String Yes The username of the user who wants to make REST calls.
password String Yes The password of the user who wants to make REST calls.
Response

A JSON object that contains an authentication token:

{
    status: "success"
    data: {
        authToken: "6IrqyFhbKjpyJZ_NX6dwLmRNxWk0OVffE8aBfauNKUG"
        userId: "a6gA9rYaGTFKPrT5P"
    }
}

Example

curl /api/v1/login
    -H "Content-Type: application/json" \
    -X POST \
    -d '{
        "username":"username",
        "password":"password"
    }’

results matching ""

    No results matching ""