Response

Authentication Response Parameters

After a successful authentication request, the API will return the following parameters:

Parameter Description
key* The session key for the authenticated user. This key must be used in subsequent API requests.
link* Authentication link for the user to follow. This link contains the session key (as the ekey parameter).
Redirection: If you provided a redirect_url parameter in your authentication request, the link will contain this URL as a parameter. When users follow this link, they will be immediately redirected to the specified URL.

Example Response

{
  "key": "a49a3069b7f1641e4a27feb3b1c00f95",
  "link": "https://www.venddor.com.br/auth/?ekey=a49a3069b7f1641e4a27feb3b1c00f95"
}

Example Response with Redirect

{
  "key": "a49a3069b7f1641e4a27feb3b1c00f95",
  "link": "https://www.venddor.com.br/auth/?ekey=a49a3069b7f1641e4a27feb3b1c00f95&redirect_url=https://example.com/callback"
}