Authenticate

This will create an API AccessToken for an Application

post

Return HTTP Status Code 200 (OK) with AccessToken Returns HTTP Status Code 400 if could not authenticate

Body

ClientIdstringRequired

Unique identifier for the API Partner; provided by FrontStream

ClientSecretstring · max: 500Required

Key specifically paired to the clientId

Responses

200

Success

application/json

Tokenstring · nullableOptional

This is the AccessToken you will use for any other API call

ClientIdstring · uuidOptional

Unique identifier for the API Partner; provided by FrontStream

ExpirationDatestring · date-timeOptional

The date and time at which the AccessToken will no longer be valid if not used first. Will always be 5 hours from when the response is sent.

400

Bad Request

application/json

post/api/ClientSession

POST /api/ClientSession HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 41

{
  "ClientId": "text",
  "ClientSecret": "text"
}

{
  "Token": "text",
  "ClientId": "123e4567-e89b-12d3-a456-426614174000",
  "ExpirationDate": "2026-01-01T00:00:00.000Z"
}