API SSO

SSO

Builds a one-time single sign-on URL for an existing person so they can land in the fair already logged in.

Authentication

All data API calls are POST (unless noted) with JSON body:

Field	Required	Description
ApiKey	Yes	Private API key for your site.
FairId	Yes	Fair GUID from the site URL (f query parameter).
Body	Depends	Request payload. Use {} when no body fields are needed.

Calls must be run server-side — do not expose your API key in a browser.

Response envelope

Most endpoints return:

{
  Success: true,
  Message: null,   // error text when Success is false
  Body: { ... }    // endpoint-specific payload
}

Request

fetch('/api/data/SSO', {
    method:'POST',
    headers:{'Content-Type': 'application/json'},
    body: JSON.stringify({
            ApiKey:'<Private key>',
            FairId: '9df61f13-474b-442f-ac1f-edca7348ef71', // value of f in your URL
            Body: {
				PersonId: "32161f13-474b-442f-ac1f-edca7348e000"
			}
        })
})
.then(response => response.json())
.then(data=>{console.log('Success: ',data);})
.catch((error)=>{console.log('Error: ', error);});

Response

On success:

{
  Success: true,
  Message: null,
  Body: {
    Sso: "https://yoursite.zfairs.com/...?f=...&sso=TOKEN"
  }
}

Person not found:

{ Success: false, Message: "Person not found!" }

Field notes

• PersonId is the person's public GUID (from add person, teachers, judges, participants).
• The person must belong to the same client as the fair.
• Treat the returned URL as a secret one-time login link; do not log it publicly.

Related APIs

• API Add Person
• API Get Teachers / API Get Judges / API Get participants