AssessorIO API v1 - Public Access
Starter OpenAPI contract for public-entry and public-assessment flows. This spec is derived from the current Next.js route handlers and is expected to evolve.
Contract Summary
- Version:
0.4.0 - Visibility:
public - Operations:
11 - Tags:
PublicAuthEntry, PublicCampaigns, PublicAssessments
Operations
| Method | Path | Summary | Operation ID |
|---|---|---|---|
| POST | /api/v1/public/auth-entry/lookup | Inspect an invitation token or public campaign link before activation. | publicAuthEntryLookup |
| GET | /api/v1/public/auth-entry/lookup | Inspect a public campaign link before activation. | publicAuthEntryLookupCampaign |
| POST | /api/v1/public/auth-entry/activate | Complete an invitation acceptance or self-join flow for an authenticated user. | publicAuthEntryActivate |
| POST | /api/v1/public/auth-entry/onboard | Set a password from an invitation and land in the campaign, in one request (B10.11, D-191/D-194). | publicAuthEntryOnboard |
| POST | /api/v1/public/campaign-code | Look up an invitation code typed on the front page (Landing C). | lookupCampaignCode |
| GET | /api/v1/public/campaigns/{campaignKey} | Resolve the public campaign shell and branding state. | getPublicCampaign |
| POST | /api/v1/public/campaigns/{campaignKey}/passcode-entry | Enter a passcode campaign with its passcode and no account (B1.14, D-052). | enterPublicCampaignWithPasscode |
| POST | /api/v1/public/campaigns/{campaignKey}/join/{token} | Redeem a colleague's unit share link and join their assessment (D-169). | joinCampaignByShareLink |
| GET | /api/v1/assessments/public/{assessmentKey} | Load the active assessment and template payload for a public assessment key. | getPublicAssessmentPayload |
| POST | /api/v1/assessments/public/{assessmentKey}/sessions/start | Mint a taker session token, optionally bound to a participant. | startPublicAssessmentSession |
| POST | /api/v1/assessments/public/{assessmentKey}/submissions | Submit answers for a public assessment. | createPublicAssessmentSubmission |