Dokumentationsmeny
Partnerspecifik Senast uppdaterad: 27 juli 2026

Datautbyte

Använd de nuvarande skrivskyddade partnerresurserna och definiera ett säkert kontrakt för partnerspecifikt utbyte av banskisser.

Parkour Design har för närvarande en samordnad, skrivskyddad resurstjänst för sammanfattningar av evenemang och banskisser. Fullständig projektgeometri, filer, skrivning och synkronisering kräver ett separat partnerkontrakt.

Kontraktets status: Slutpunkterna nedan beskriver det nuvarande driftsatta beteendet för godkända klienter. De är ännu inget versionerat allmänt API. Bygg inte mot dem innan Parkour Design har bekräftat åtkomst, scope, gränser och lanseringskontraktet.

Bas-URL och autentisering

Använd den utfärdare som valts för OAuth-miljön som API:ets bas-URL:

MiljöBas-URL
Produktionhttps://app.parkour.design
Testhttps://parkour-test.web.app

Skicka Parkour Designs åtkomsttoken från en backend-tjänst:

Authorization: Bearer <access_token>
Accept: application/json

Åtkomsttoken måste vara giltig för den konfigurerade utfärdaren och målgruppen parkour-api, ha token_use lika med access_token och för närvarande innehålla openid.

API:et ger för närvarande ingen åtkomst från webbläsare med annat ursprung. Exponera inte åtkomst- eller förnyelsetoken för JavaScript i frontend.

Lista evenemang

GET /api/events

Exempel på begäran:

curl "${ISSUER}/api/events" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/json"

Exempel 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
    }
  ]
}

Nuvarande svarstyp:

type EventSummary = {
  id: string;
  name: string;
  startDate: string | null;
  endDate: string | null;
  updatedAt: string | null;
  designCount: number;
};

type EventsResponse = {
  items: EventSummary[];
};

Evenemangen sammanställs från den autentiserade användarens projekt som inte har tagits bort. Projekt utan identifierare för evenemang utelämnas.

Behandla id som ogenomskinligt. Kopiera det oförändrat till begäran om sammanfattningar av projekt. Dra inga slutsatser om dess format och skapa det inte i partnersystemet.

Lista sammanfattningar av projekt för ett evenemang

GET /api/events/{eventId}/designs

Exempel på begäran:

curl "${ISSUER}/api/events/${EVENT_ID}/designs" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/json"

Exempel 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"
    }
  ]
}

Nuvarande svarstyp:

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[];
};

Datum är strängar enligt ISO 8601 i UTC när de finns. Klienterna måste hantera null för valfria datum och localId.

Ägarskap och synlighet

Bearer-tokens sub identifierar resursägaren i Parkour Design. Svaren innehåller bara projekt som inte har tagits bort och som ägs av den användaren.

Den nuvarande tjänsten ger inte:

  • åtkomst för hela organisationer eller team;
  • åtkomst till en annan användares delade eller offentliga projekt;
  • klientspecifik filtrering av resurser;
  • borttagna projekt;
  • uppgifter om abonnemang, profil eller betalningar.

Ett evenemang som inte finns och ett evenemang som ägs av en annan användare returnerar båda 404. Använd inte svaret för att dra slutsatser om huruvida en annan användares resurs finns.

Nuvarande gränser och ordning

De nuvarande slutpunkterna accepterar inga parametrar för filtrering, sortering, sidindelning, markörer eller inkrementell synkronisering.

  • /api/events returnerar den sammanställda listan över evenemang i ett svar.
  • /api/events/{eventId}/designs returnerar högst 500 sammanfattningar.
  • Svaret anger för närvarande inte om listan är avkortad och ger ingen markör för fortsättning.
  • Ordningen är den nuvarande implementeringens beteende och ännu ingen versionerad garanti.

Innan en integration godkänns för produktion måste Parkour Design och partnern bekräfta att den förväntade datavolymen ryms inom gränserna. En partner som behöver fullständig sidindelning eller inkrementella uppdateringar får inte kompensera genom att skrapa eller gissa identifierare; det kräver ett reviderat kontrakt.

Felsvar

Fel använder en kompakt JSON-kropp:

{"error": "not_found"}
StatusFelBetydelse
401invalid_tokenSaknad, felformaterad, utgången, ogiltig eller för närvarande otillräckligt avgränsad bearer-token
404not_foundOgiltig sökväg eller evenemang som inte är tillgängligt för användaren
405method_not_allowedAnnan metod än GET

Oväntade fel i tjänsten har ännu inget separat versionerat felschema. Klienterna ska bara behandla andra 5xx-svar som möjliga att försöka igen för idempotenta GET-operationer, med begränsad exponentiell backoff och jitter.

Data som inte exponeras av API:et

Sammanfattningen av ett projekt är ingen fullständig banskiss. Det nuvarande resurs-API:et exponerar inte:

  • banans geometri eller väg;
  • hinder, grupper, arenans uppställning eller ritobjekt;
  • skapade PDF:er, förhandsvisningar, bilder eller URL:er för nedladdning;
  • operationer för att skapa, uppdatera, ta bort eller ladda upp;
  • uppslag av ett enskilt projekt via dess ID;
  • webhooks eller ett ändringsflöde;
  • Eqifys åtkomsttoken, sessioner, klasser, aktiviteter eller sparade mål.

Presentera inte ett svar med sammanfattningar som en banskiss att skriva ut eller redigera.