Offentlig API-översikt
Offentlig API-översikt
DistantRace erbjuder ett REST API (/api/v1/) som används av mobilappen, partnerintegrationer och whitelabel-plattformar. Detta är en översikt på hög nivå — inte en fullständig OpenAPI-referens.
Integrationsstöd
API-åtkomst för tredjepartsutveckling arrangeras vanligtvis med DistantRace-support. Autentisering och hastighetsbegränsningar gäller.
Bas-URL #
https://distantrace.com/api/v1/
Autentisering #
| Beviljande / token | Typisk anropare | Omfattning |
|---|---|---|
| Session / mobil token | DistantRace-app, inloggad web | Användarspecifik läs/skriv |
Org token (client_credentials) |
Whitelabel portal backend | Offentliga listor, validera/lösa in join-kod, hero-bilder |
| User OAuth (auktoriseringskod + uppdatering) | Whitelabel SPA efter inloggning | Gå med, träningspass, profil, kassa |
Whitelabel-integrationer använder två typer av autentiseringsuppgifter:
| Autentiseringsuppgift | Användning |
|---|---|
| Org token (långlivad bärare) | Offentliga evenemangs-/utmaningslistor, hero-bilder, validering av join-kod, inlösen av e-posttoken |
| User OAuth client (auktoriseringskod) | Deltagarinloggning, gå med i evenemang, träningspass, profil, kassa |
Org-token löses från OAuth-applikationsägaren — varje whitelabel API-anrop är implicit kopplat till en klubb.
Kontots slutpunkter inkluderar inloggnings-QR, social inloggning, profil (/api/v1/account/me/) och enhetsregistrering.
Se Whitelabel och företagsinställning för den fullständiga deltagarportalmodellen.
Whitelabel join-kodflöden #
| Slutpunkt | Metod | Syfte |
|---|---|---|
event/joincode/{code}/validate/ |
GET | Kontrollera om en kod är aktiv för din organisation; returnerar offentlig evenemangsdata (ingen deltagar-PII) |
event/joincode/redeem-email-token/ |
POST | Använd en magic-link-token från ett inbjudningsmail; returnerar OAuth-token och kan automatiskt registrera i en utmaning |
event/joincode/ |
POST | Skapa en join-kod och skicka inbjudningsmail (endast administratörsanvändartoken — inte den offentliga org-token) |
Magic-link-inlösen använder org-token plus en engångs-token i POST-kroppen. Servern kan skapa en användare från join-kodens förifyllnadsdata, utfärda åtkomst-/uppdateringstoken och kalla på automatisk registrering när koden är bunden till en utmaning.
Hero-bilder (endast whitelabel) #
GET orgs/hero-images/?language=<code> — aktiva karusellbilder för tokenets organisation. Kräver is_whitelabel på klubben. Valfri språkfilter returnerar lokalspecifika bilder plus språkneutrala reservbilder.
Huvudresursgrupper #
| Prefix | Resurser |
|---|---|
event/ |
Evenemang, join-koder, inlägg |
gamification/ |
Utmaningar, utmanare, lagutmaningar, mål, daglig statistik |
races/ |
Tävlingar, deltagare (löpare), resultat |
shop/ |
Kundvagnar, kundvagnsartiklar, produkter, premium-nivåer |
users/ |
Användare, deltagare, push-enheter |
workouts/ |
Aktiviteter, uppladdning, sport/typ-metadata |
orgs/ |
Organisationer, hero-bilder (whitelabel) |
finances/ |
Betalningskanaler, prisassistenter |
Vanliga integrationstasks #
| Uppgift | Typiska slutpunkter |
|---|---|
| Lista publicerade evenemang | event/event/ |
| Registrera deltagare | races/registration/entrant/ |
| Synkronisera aktiviteter | workouts/ eller workouts/upload/ |
| Läs resultat | races/result/ |
| Mobila dagliga steg | gamification/dailystat/ |
Företags-SSO #
SAML-slutpunkter (plattformens autentiseringsvärd):
| Sökväg | Syfte |
|---|---|
/saml2/discovery/ |
Ange arbets-e-post → dirigera till rätt IdP efter domän |
/saml2/login/ |
Starta SAML-autentisering (valfria idp och next frågeparametrar) |
/saml2/acs/ |
Assertion consumer (IdP callback) |
/saml2/metadata/ |
Tjänsteleverantörsmetadata för IdP-konfiguration |
När flera identitetsleverantörer finns, matchar discovery e-postens domän till en IdP innan omdirigering till inloggning. Med en enda IdP hoppar discovery direkt till /saml2/login/.
Deltagar- och personalflöden: Företags-SAML och whitelabel-inloggning.
Dataexportalternativ #
För engångskalkylblad utan kodning, använd manager exporter — Organisatördokument, Exportera resultatdata, Årlig inkomstexport.