Introduction

You can use this API to get your User Token by providing your Access Key and Secret Key.


Good to know

Work in progress:

This API is rapidly being expanded on, and you may experience changes to it.

This changes can include (but are not limited to); authentication, response structure, and parameters.


Forgot your Access Key/Secret Key?:

If you don't have your access key and secret key, please contact your Customer Success Manager; they'll be able to (re-)generate them for you.

Make sure you store these somewhere safe!


About this API

Resource Information

Response formatsText (or JSON on error)
HTTP MethodPUT
Response familyUsers


Resource URL

Europe Production Server: https://login.eu.customergauge.com/api/users/token

US Production Server: https://login.us.customergauge.com/api/users/token

Australia Production Server: https://login.au.customergauge.com/api/users/token


How to call

POST Data

Post data as body (form-data)


Body

KeyData
access_key (required)XXXXX
secret_key (required)YYYYY


Example Request

To call this API through cURL:

curl -X POST https://login.eu.customergauge.com/api/users/token -F access_key=XXXXX -F secret_key=YYYYY


Example Result

Message reported on successful operation:

1JGFr375qr87twr28IWFYGD7t2rx5q3x


Message reported on failed operation:

{
    "message": "The given data was invalid.",
    "errors": {
        "access_key": [
            "validation.required"
        ],
        "secret_key": [
            "validation.required"
        ]
    }
}


Not the API you're looking for?

View: