VEvetcove
Accounts

Auto-authenticate a client

This endpoint is available to Group API Keys only.

Generates an auto-authentication token that allows a clinic client (pet parent) to be seamlessly signed into the Vetcove client shopping portal without requiring them to enter credentials.

This is typically used to provide a direct link from an application or client communication into the Vetcove shopping experience. The client is identified by their email address or phone number.

post/ext/v2/accounts/auto-auth/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/accounts/auto-auth/
  • Auth
    HTTP bearer

Request body

client_emailstring nullable

The client's email address. At least one of client_email, client_phone_number, or clinic_client_user_id must be provided.

client_phone_numberinteger nullable

The client's phone number. At least one of client_email, client_phone_number, or clinic_client_user_id must be provided.

clinic_client_user_idinteger nullable

The ID of the clinic client user to authenticate. When provided, client_email and client_phone_number are ignored. At least one of client_email, client_phone_number, or clinic_client_user_id must be provided.

clinic_idinteger required

The ID of the clinic the client belongs to

Response

Created

auto_auth_tokenstring required

The generated auto-authentication token.

base_urlstring required

The base URL for the Vetcove client shopping portal with the auto-auth token applied.

embed_urlstring required

A URL for the Vetcove client shopping portal designed to be embedded in an iframe.

expiryinteger required

The expiry time of the token, as a Unix timestamp in seconds.

fullscreen_urlstring required

A URL for the Vetcove client shopping portal designed for fullscreen browser use.

Changes

No recorded changes to this operation across all 1 revision of this API.