Authentication

Generate seamless sign-in links for partner locations.

Request location one-time sign-in link

post

Generate a short-lived, one-time URL to auto-authenticate a specific location into the Fyre interface.

Note on Domains: The domain in the returned redirect_url will vary depending on your white-label configuration (e.g., bo.fyre.app vs your-brand.com).

Required Permission: locations.auth.link

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Standard API Key authentication.

Body

application/json

fyre_idstringRequired

The unique identifier for the location.

Example: FR0100000000

Responses

200

Success. Use the returned URL to redirect the user.

application/json

redirect_urlstring · uriOptional

The one-time sign-in link. Valid for 5 minutes.

Example: https://bo.fyre.app/auth?oobCode=GKJ8HBnlVvHHNblJV5hojyCZu3cr3OcP7dkQuzOPS5w2GUwZpufr3j&mode=login

401

Unauthorized

application/json

post

/auth/signin/request

cURLJavaScript (Axios)

curl --request POST \
  --url https://api.fyre.app/api/v1/auth/signin/request \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: YOUR_TOKEN' \
  --data '{
	"fyre_id": "FR0100000000"
}'

{
  "redirect_url": "https://bo.fyre.app/auth?oobCode=GKJ8HBnlVvHHNblJV5hojyCZu3cr3OcP7dkQuzOPS5w2GUwZpufr3j&mode=login"
}