Skip to main content

Authentication

The Fraugster API utilizes JSON Web Tokens (JWT) for authorization when accessing its resources. All endpoints, with the exception of the login endpoint, necessitate a valid JWT for authentication. The JWT must be included in the Authorization header and follow this format: SessionToken VALIDSESSIONTOKEN. Failure to provide a valid JWT will result in a server response with the HTTP status code 401 (unauthorized).

It's important to note that tokens have a maximum validity period of 24 hours. To ensure continuous access, use a token as long as it remains valid, and reauthenticate when it expires. It's crucial to configure your integration to automatically retry the login process upon detecting a 401 response. Avoid logging in with every transaction sent to the Fraugster API, as this can introduce delays in the response time.

Get a valid JWT

To get a valid JWT, you must log in via the Fraugster API. The Fraugster API uses HTTP basic authentication scheme as defined in RFC 7617, which transmits credentials as user ID/password pairs, encoded using base64.

You receive your login credentials during the onboarding process. Here is an example:

  • user: companyname

    A human-readable string in lowercase that uniquely identifies you on Fraugster's end.

  • password: aishahy0chi4ci5ahhohdaivah8iowoo5pua4pangaichaixexojohpohf3eeGhu

    Randomly generated 64 lowercase characters and numbers.

HTTP endpoint

POST/api/v2/sessions

Request example

curl -i --user 'user:password' -X POST https://api-perf.fraugsterapi.com/api/v2/sessions

In the example above, make sure to replace user and password with your actual data.

This request returns a response with a header and a JSON body. The body contains a single entry "sessionToken". Its value is used in all the interactions with the API.

Response example

HTTP/1.1 200 OK
Date: Fri, 04 Dec 2018 12:35:32 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 641
Connection: keep-alive
{
"sessionToken": "eyJhdWQiOiIiLCJleHAiOjE1NTM4NTk3NTMsImlhdCI6MTU1Mzc3MzM1MiwiaXNzIjoiZnJhdWdzdGVyIiwianRpIjoiNGEwYzgxMGMtZmRjMC00MDdlLTlmYWQtOWIzZjU2MTY4ZmI1Iiwic2NwIjpbIm1lcmNoYW50LWFwaSIsImNsaWVudC5mcmF1Z3N0ZXIiXSwic3ViIjoiZnJhdWdzdGVyIiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.zGR0ST5cmc5-ALCLzPXOT9F5a2YvJQ61NAnLJAqf7Vk"
}