Offentlig API-oversikt
Offentlig API-oversikt
DistantRace tilbyr en REST API (/api/v1/) som brukes av mobilappen, partnerintegrasjoner og whitelabel-plattformer. Dette er et oversiktskart — ikke en fullstendig OpenAPI-referanse.
Integrasjonsstøtte
API-tilgang for tredjepartsutvikling avtales vanligvis med DistantRace-støtte. Autentisering og hastighetsbegrensninger gjelder.
Basis-URL #
https://distantrace.com/api/v1/
Autentisering #
| Tillatelse / token | Typisk innringer | Omfang |
|---|---|---|
| Session / mobile token | DistantRace-app, innlogget web | Brukeromfang les/skriv |
Org token (client_credentials) |
Whitelabel portal backend | Offentlige lister, validering/innløsning av join-kode, hero-bilder |
| User OAuth (autorisasjonskode + oppfriskning) | Whitelabel SPA etter innlogging | Bli med, treningsøkter, profil, utsjekk |
Whitelabel-integrasjoner bruker to typer legitimasjon:
| Legitimasjon | Bruk |
|---|---|
| Org token (langvarig bearer) | Offentlige arrangement/utfordringslister, hero-bilder, validering av join-kode, innløsning av e-posttoken |
| User OAuth client (autorisasjonskode) | Deltakerinnlogging, bli med på arrangementer, treningsøkter, profil, utsjekk |
Org-tokenet er løst fra eieren av OAuth-applikasjonen — hver whitelabel API-anrop er implisitt knyttet til én klubb.
Kontopunkter inkluderer innloggings-QR, sosial innlogging, profil (/api/v1/account/me/) og enhetsregistrering.
Se Whitelabel og bedriftsoppsett for den fullstendige deltakerportalmodellen.
Whitelabel join-kode flyter #
| Endepunkt | Metode | Formål |
|---|---|---|
event/joincode/{code}/validate/ |
GET | Sjekk om en kode er aktiv for din organisasjon; returnerer offentlig arrangementspayload (ingen deltaker-PII) |
event/joincode/redeem-email-token/ |
POST | Bruk en magic-link token fra en invitasjons-e-post; returnerer OAuth-tokens og kan automatisk registrere i en utfordring |
event/joincode/ |
POST | Opprett en join-kode og send invitasjons-e-post (kun admin brukertoken — ikke det offentlige org-tokenet) |
Magic-link innløsning bruker org-tokenet pluss en engangs token i POST-kroppen. Serveren kan opprette en bruker fra join-kode forhåndsutfyllingsdata, utstede tilgangs-/oppfriskningstokens, og kalle auto-registrering når koden er bundet til en utfordring.
Hero-bilder (kun whitelabel) #
GET orgs/hero-images/?language=<code> — aktive karusellbilder for tokenets organisasjon. Krever is_whitelabel på klubben. Valgfritt språkfilter returnerer lokalspesifikke bilder pluss språknøytrale reservemuligheter.
Hovedressursgrupper #
| Prefiks | Ressurser |
|---|---|
event/ |
Arrangementer, join-koder, innlegg |
gamification/ |
Utfordringer, utfordrere, lagutfordringer, mål, daglig statistikk |
races/ |
Konkurranser, deltakere (løpere), resultater |
shop/ |
Handlekurver, handlekurvartikler, produkter, premium nivåer |
users/ |
Brukere, deltakere, push-enheter |
workouts/ |
Aktiviteter, opplasting, sport/type metadata |
orgs/ |
Organisasjoner, hero-bilder (whitelabel) |
finances/ |
Betalingskanaler, prisverktøy |
Vanlige integrasjonsoppgaver #
| Oppgave | Typiske endepunkter |
|---|---|
| Liste over publiserte arrangementer | event/event/ |
| Registrere deltaker | races/registration/entrant/ |
| Synkronisere aktiviteter | workouts/ eller workouts/upload/ |
| Lese resultater | races/result/ |
| Mobile daglige skritt | gamification/dailystat/ |
Bedrifts-SSO #
SAML-endepunkter (plattformautentiseringsvert):
| Sti | Formål |
|---|---|
/saml2/discovery/ |
Skriv inn arbeidse-post → rute til riktig IdP etter domene |
/saml2/login/ |
Start SAML-autentisering (valgfri idp og next forespørselsparametere) |
/saml2/acs/ |
Påstandsforbruker (IdP-tilbakeringing) |
/saml2/metadata/ |
Tjenesteleverandørmetadata for IdP-konfigurasjon |
Når flere identitetsleverandører eksisterer, matcher discovery e-postens domene til en IdP før omdirigering til innlogging. Med en enkelt IdP, hopper discovery direkte til /saml2/login/.
Deltaker- og personalflyter: Bedrifts-SAML og whitelabel-innlogging.
Dataeksportalternativ #
For engangsregneark uten koding, bruk manager eksporter — Arrangørdokumenter, Eksportere resultatdata, Årlig inntektseksport.