Parkour Design har i øjeblikket en koordineret, skrivebeskyttet ressourcetjeneste med oversigter over stævner og baneskitser. Fuldstændig projektgeometri, filer, skrivning og synkronisering kræver en separat partnerkontrakt.
Kontraktens status: Endpoints nedenfor beskriver den nuværende adfærd i drift for godkendte klienter. De er endnu ikke et versioneret offentligt API. Byg ikke mod dem, før Parkour Design har bekræftet adgang, scopes, grænser og lanceringskontrakten.
Basis-URL og autentificering
Brug den udsteder, der er valgt for OAuth-miljøet, som API’ets basis-URL:
| Miljø | Basis-URL |
|---|---|
| Produktion | https://app.parkour.design |
| Test | https://parkour-test.web.app |
Send Parkour Designs adgangstoken fra en backend-tjeneste:
Authorization: Bearer <access_token>
Accept: application/json
Adgangstokenet skal være gyldigt for den konfigurerede udsteder og audience parkour-api, have token_use lig med access_token og i øjeblikket indeholde openid.
API’et giver i øjeblikket ikke adgang fra browsere med en anden oprindelse. Eksponér ikke adgangstokens eller refresh tokens for JavaScript i frontend.
Liste over stævner
GET /api/events
Eksempel på anmodning:
curl "${ISSUER}/api/events" \
--header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/json"
Eksempel på svar:
{
"items": [
{
"id": "abcdefghijklmnopqrstuv",
"name": "Example Event",
"startDate": "2026-07-24T00:00:00Z",
"endDate": "2026-07-26T00:00:00Z",
"updatedAt": "2026-07-26T18:42:10Z",
"designCount": 4
}
]
}
Nuværende svartype:
type EventSummary = {
id: string;
name: string;
startDate: string | null;
endDate: string | null;
updatedAt: string | null;
designCount: number;
};
type EventsResponse = {
items: EventSummary[];
};
Stævnerne udledes af den autentificerede brugers projekter, der ikke er slettet. Projekter uden en identifikator for stævne udelades.
Behandl id som uigennemsigtig. Kopiér den uændret til anmodningen om projektoversigter. Drag ikke konklusioner om dens format, og opret den ikke i partnersystemet.
Liste over projektoversigter for et stævne
GET /api/events/{eventId}/designs
Eksempel på anmodning:
curl "${ISSUER}/api/events/${EVENT_ID}/designs" \
--header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/json"
Eksempel på svar:
{
"event": {
"id": "abcdefghijklmnopqrstuv",
"name": "Example Event",
"startDate": "2026-07-24T00:00:00Z",
"endDate": "2026-07-26T00:00:00Z",
"updatedAt": "2026-07-26T18:42:10Z",
"designCount": 4
},
"items": [
{
"id": "design-record-id",
"localId": "design-local-id",
"eventId": "abcdefghijklmnopqrstuv",
"title": "Grand Prix",
"eventName": "Example Event",
"eventDate": "2026-07-26T00:00:00Z",
"updatedAt": "2026-07-26T18:42:10Z",
"authorName": "Course Designer",
"shortDescr": "Competition description"
}
]
}
Nuværende svartype:
type DesignSummary = {
id: string;
localId: string | null;
eventId: string;
title: string;
eventName: string;
eventDate: string | null;
updatedAt: string | null;
authorName: string | null;
shortDescr: string;
};
type EventDesignsResponse = {
event: EventSummary;
items: DesignSummary[];
};
Datoer er strenge efter ISO 8601 i UTC, når de findes. Klienterne skal håndtere null for valgfrie datoer og localId.
Ejerskab og synlighed
Bearer tokenets sub identificerer ressourceejeren i Parkour Design. Svarene indeholder kun projekter, der ikke er slettet, og som ejes af den bruger.
Den nuværende tjeneste giver ikke:
- adgang for hele organisationer eller teams;
- adgang til en anden brugers delte eller offentlige projekter;
- klientspecifik filtrering af ressourcer;
- slettede projekter;
- oplysninger om abonnement, profil eller betalinger.
Et stævne, der ikke findes, og et stævne, der ejes af en anden bruger, returnerer begge 404. Brug ikke svaret til at udlede, om en anden brugers ressource findes.
Nuværende grænser og rækkefølge
De nuværende endpoints accepterer ingen parametre for filtrering, sortering, sideinddeling, cursors eller inkrementel synkronisering.
/api/eventsreturnerer den udledte liste over stævner i ét svar./api/events/{eventId}/designsreturnerer højst 500 oversigter.- Svaret angiver i øjeblikket ikke, om listen er afkortet, og giver ingen cursor til fortsættelse.
- Rækkefølgen er den nuværende implementerings adfærd og endnu ikke en versioneret garanti.
Før en integration godkendes til produktion, skal Parkour Design og partneren bekræfte, at den forventede datamængde ligger inden for grænserne. En partner, der har brug for fuld sideinddeling eller inkrementelle opdateringer, må ikke kompensere ved at skrabe eller gætte identifikatorer; det kræver en revideret kontrakt.
Fejlsvar
Fejl bruger en kompakt JSON-krop:
{"error": "not_found"}
| Status | Fejl | Betydning |
|---|---|---|
401 | invalid_token | Manglende, forkert formateret, udløbet, ugyldigt eller i øjeblikket utilstrækkeligt afgrænset bearer token |
404 | not_found | Ugyldig sti eller stævne, der ikke er tilgængeligt for brugeren |
405 | method_not_allowed | Anden metode end GET |
Uventede fejl i tjenesten har endnu ikke et separat versioneret fejlskema. Klienterne bør kun behandle andre 5xx-svar som mulige at prøve igen for idempotente GET-operationer, med begrænset eksponentiel backoff og jitter.
Data, som API’et ikke eksponerer
En projektoversigt er ikke en fuldstændig baneskitse. Det nuværende ressource-API eksponerer ikke:
- banens geometri eller ridevej;
- forhindringer, grupper, ridebanens opstilling eller tegneobjekter;
- oprettede PDF’er, forhåndsvisninger, billeder eller URL’er til download;
- operationer til at oprette, opdatere, slette eller uploade;
- opslag af et enkelt projekt via dets ID;
- webhooks eller et ændringsflow;
- Eqifys adgangstokens, sessioner, klasser, aktiviteter eller gemte modtagere.
Præsentér ikke et svar med oversigter som en baneskitse til udskrivning eller redigering.