πŸ”Auth

This API route allows you to request a one-time sign-in link for a specific location. The link generated by this request is valid for 5 minutes and can be used only once.

Once the request is successful, you will receive a redirect_url in the response. You can use this URL to redirect the user to complete the sign-in process, or alternatively, embed it in an iframe to allow users to sign in directly within your application

POST https://api.fyre.app/api/v1/auth/signin/request

Requires permission:

  • locations.auth.link

⬇️ Payload

Parameter
Type
Explanation
Mandatory

fyre_id

string

The unique identifier for the location for which you are requesting the sign-in link.

βœ…

πŸ“– Payload Example

{
    fyre_id: "FR0100000000"
}

πŸ“€ Responses

200 - Success
{
    "redirect_url": "https://bo.mylemonade.fr/auth?oobCode=GKJ8HBnlVvHHNblJV5hojyCZu3cr3OcP7dkQuzOPS5w2GUwZpufr3j&mode=login"
}
401 - Unauthorized
{
  "status": 401,
  "message": "Request Authorization not found",
  "code": "AUTHORIZATION_NOT_FOUND",
  "value": ""
}

Last updated