Offentlig API oversigt
Offentlig API oversigt
DistantRace tilbyder en REST API (/api/v1/) brugt af mobilappen, partnerintegrationer og whitelabel-platforme. Dette er et overordnet kort — ikke en fuld OpenAPI-reference.
Integration support
API-adgang for tredjepartsudvikling arrangeres typisk med DistantRace support. Autentifikation og hastighedsbegrænsninger gælder.
Basis-URL #
https://distantrace.com/api/v1/
Autentifikation #
| Grant / token | Typisk opkalder | Omfang |
|---|---|---|
| Session / mobile token | DistantRace app, logget ind på web | Bruger-specifik læse/skrive |
Org token (client_credentials) |
Whitelabel portal backend | Offentlige lister, join-code validering/indløsning, hero billeder |
| User OAuth (autoriseringskode + opdatering) | Whitelabel SPA efter login | Deltagelse, træninger, profil, betaling |
Whitelabel integrationer bruger to typer legitimationsoplysninger:
| Legitimationsoplysning | Brug |
|---|---|
| Org token (langvarig bearer) | Offentlige event/udfordringslister, hero billeder, join-code validering, email-token indløsning |
| User OAuth client (autoriseringskode) | Deltager login, deltagelse i events, træninger, profil, betaling |
Org token er afledt fra OAuth applikationsejeren — hvert whitelabel API-kald er implicit knyttet til én klub.
Kontoendepunkter inkluderer login QR, social login, profil (/api/v1/account/me/) og enhedsregistrering.
Se Whitelabel og virksomhed opsætning for den fulde deltagerportalmodel.
Whitelabel join-code flows #
| Endepunkt | Metode | Formål |
|---|---|---|
event/joincode/{code}/validate/ |
GET | Tjek om en kode er aktiv for din organisation; returnerer offentlig event payload (ingen deltager PII) |
event/joincode/redeem-email-token/ |
POST | Brug en magic-link token fra en invitation email; returnerer OAuth tokens og kan automatisk tilmelde til en udfordring |
event/joincode/ |
POST | Opret en join code og send invitation email (kun admin brugertoken — ikke den offentlige org token) |
Magic-link indløsning bruger org token plus en engangs token i POST body. Serveren kan oprette en bruger fra join-code forudfyldningsdata, udstede adgangs/opdateringstokens, og kalde auto-tilmelding når koden er bundet til en udfordring.
Hero billeder (kun whitelabel) #
GET orgs/hero-images/?language=<code> — aktive karuselbilleder for tokenets organisation. Kræver is_whitelabel på klubben. Valgfrit sprogfilter returnerer lokalitetsspecifikke billeder plus sprogneutrale alternativer.
Hovedressourcegrupper #
| Præfiks | Ressourcer |
|---|---|
event/ |
Events, join codes, opslag |
gamification/ |
Udfordringer, udfordringsdeltagere, holdudfordringer, mål, daglig statistik |
races/ |
Konkurrencer, deltagere (løbere), resultater |
shop/ |
Kurve, kurveelementer, produkter, premium niveauer |
users/ |
Brugere, deltagere, push-enheder |
workouts/ |
Aktiviteter, upload, sport/type metadata |
orgs/ |
Organisationer, hero billeder (whitelabel) |
finances/ |
Betalingskanaler, prisassistenter |
Almindelige integrationstasks #
| Opgave | Typiske endepunkter |
|---|---|
| Liste over offentliggjorte events | event/event/ |
| Registrer deltager | races/registration/entrant/ |
| Synkroniser aktiviteter | workouts/ eller workouts/upload/ |
| Læs resultater | races/result/ |
| Mobile daglige skridt | gamification/dailystat/ |
Enterprise SSO #
SAML endepunkter (platform auth host):
| Sti | Formål |
|---|---|
/saml2/discovery/ |
Indtast arbejdsemail → rute til den korrekte IdP efter domæne |
/saml2/login/ |
Start SAML autentifikation (valgfri idp og next forespørgselsparametre) |
/saml2/acs/ |
Assertion consumer (IdP callback) |
/saml2/metadata/ |
Service-provider metadata til IdP konfiguration |
Når der findes flere identitetsudbydere, matcher discovery email domænet til en IdP før omdirigering til login. Med en enkelt IdP springer discovery direkte til /saml2/login/.
Deltager- og personaleflows: Enterprise SAML og whitelabel login.
Dataeksportalternativ #
For engangsspreadsheets uden kodning, brug manager eksporter — Organisator dokumenter, Eksport af resultater data, Årlig indkomst eksport.