Get an Authentication Token (API V2 only)

post/token

Retrieves the access token, token type and the refresh token.

Securitybasic or X-PriceFx-jwt
Request
header Parameters
Pricefx-Key
required
string

The Pricefx API key. Contact Pricefx Support to get your Pricefx-Key.

Request Body schema: application/json
username
required
string non-empty
partition
required
string non-empty
password
required
string non-empty

A clear-text password.

Responses
200

Login was successful. The response contains the access token, token type and the refresh token.

Response Schema: application/json
access-token
required
string non-empty
refresh-token
required
string non-empty
token-type
required
string non-empty
expires-in
required
number
400

The request was malformed.

401

Unauthorized - the login credentials were incorrect.

403

Forbidden - The request did not contain a valid Pricefx-Key, the provided credentials in body were incorrect, the user was banned or not found or device registration required.

Request samples
application/json
{
  • "username": "string",
  • "partition": "string",
  • "password": "string"
}
Response samples
application/json
{
  • "access-token": "string",
  • "refresh-token": "string",
  • "token-type": "string",
  • "expires-in": 0
}