Skip to content

Authentication

Member-facing Authentication endpoints for your storefront.

Operations

Authenticate a member

Request

Authenticates a user and returns a JWT token. This token is used to authenticate the user for all other storefront requests. JWTs expire after 2 hours.

Security
api_key
Bodyapplication/jsonrequired
merchantIdstringrequired

Your merchantId. You can obtain this by calling the GET merchant endpoint.

usrEmailstringrequired

The amount to be awarded upon sign-up.

usrPasswdstringrequired

The name (appearance only) of this benefit.

curl -i -X POST \
  https://public.inveterateapi.com/v2.0/storefront/auth \
  -H 'Content-Type: application/json' \
  -H 'X-Inveterate-Api-Key: YOUR_API_KEY_HERE' \
  -d '{
    "merchantId": "string",
    "usrEmail": "string",
    "usrPasswd": "string"
  }'

Responses

Returned upon successful direct action to our database. Action is immediate.

Bodyapplication/json
messagestringrequired

The message associated with the response. Generally, the message only confirms the requested action. In the case of errors, the message will give insight into the source of the error.

dataobjectrequired

The data associated with the response. Data is only returned from errors if the error originates from our backend to give further insight into the nature of the error.

Response
{
  "message": "Success",
  "data": {
    "id": 1,
    "name": "John Doe"
  }
}