v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Loyalty
Members
Authentication

Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie

The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token).

Providing this cookie with subsequent requests works as an alternative to the LoyaltySessionToken HTTP header.

Sign out is handled by the ExpireAuthenticationCookie method.

When using cookie-based authentication, the API will automatically refresh the cookie when the access token has expired.

In addition to the authentication cookie, a second vista-loyalty-member-is-authenticated cookie is returned that can be used by the client to detect whether the patron is authenticated.

Data is to be provided as application/x-www-form-urlencoded form parameters in the format of member workstation authentication request

Unlike the standard member authentication endpoints, the cookie from this endpoint does not have permission to update member details.

Error Response

LockOutPeriodInSeconds property will only be present on the response object if the response has the error code 32000.

Licenses Required

  • Vista.Ocapi
post/ocapi/v1/members/workstation-authentication-cookie

Headers

Connect-Region-Codestring

Region Code

Response

Member authenticated cookies created.