Nabídka dokumentace
Pro konkrétního partnera Naposledy aktualizováno: 27. července 2026

Výměna dat

Používejte současné partnerské zdroje pouze pro čtení a definujte bezpečný kontrakt pro výměnu plánů parkuru specifickou pro partnera.

Parkour Design v současnosti provozuje koordinovanou službu zdrojů pouze pro čtení se souhrny akcí a plánů parkuru. Úplná geometrie projektu, soubory, zápis a synchronizace vyžadují samostatný partnerský kontrakt.

Stav kontraktu: Endpointy níže popisují současné nasazené chování pro schválené klienty. Zatím nejde o verzované veřejné API. Nestavějte proti nim, dokud Parkour Design nepotvrdí přístup, scope, limity a kontrakt pro spuštění.

Základní URL a autentizace

Jako základní URL API použijte vydavatele zvoleného pro prostředí OAuth:

ProstředíZákladní URL
Produkcehttps://app.parkour.design
Testhttps://parkour-test.web.app

Přístupový token Parkour Design posílejte z backendové služby:

Authorization: Bearer <access_token>
Accept: application/json

Přístupový token musí být platný pro nakonfigurovaného vydavatele a cílovou skupinu parkour-api, mít token_use rovno access_token a v současnosti obsahovat openid.

API v současnosti neumožňuje přístup z prohlížečů z jiného původu. Přístupové ani obnovovací tokeny nezpřístupňujte JavaScriptu ve frontendu.

Seznam akcí

GET /api/events

Příklad požadavku:

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

Příklad odpovědi:

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

Současný typ odpovědi:

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

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

Akce se sestavují z nesmazaných projektů ověřeného uživatele. Projekty bez identifikátoru akce se vynechávají.

S id zacházejte jako s neprůhledným. Zkopírujte ho beze změny do požadavku na souhrny projektů. Nevyvozujte nic z jeho formátu a nevytvářejte ho v systému partnera.

Seznam souhrnů projektů akce

GET /api/events/{eventId}/designs

Příklad požadavku:

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

Příklad odpovědi:

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

Současný typ odpovědi:

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

Data jsou řetězce ve formátu ISO 8601 v UTC, pokud jsou k dispozici. Klienti musí zvládnout null u volitelných dat a localId.

Vlastnictví a viditelnost

sub bearer tokenu identifikuje vlastníka zdroje v Parkour Design. Odpovědi obsahují jen nesmazané projekty vlastněné tímto uživatelem.

Současná služba neposkytuje:

  • přístup pro celé organizace nebo týmy;
  • přístup ke sdíleným ani veřejným projektům jiného uživatele;
  • filtrování zdrojů podle klienta;
  • smazané projekty;
  • údaje o předplatném, profilu ani platbách.

Neexistující akce i akce vlastněná jiným uživatelem vrátí shodně 404. Z odpovědi nevyvozujte, zda zdroj jiného uživatele existuje.

Současné limity a pořadí

Současné endpointy nepřijímají parametry pro filtrování, řazení, stránkování, kurzory ani přírůstkovou synchronizaci.

  • /api/events vrátí sestavený seznam akcí v jedné odpovědi.
  • /api/events/{eventId}/designs vrátí nejvýše 500 souhrnů.
  • Odpověď v současnosti neuvádí, zda byl seznam zkrácen, a neposkytuje kurzor pro pokračování.
  • Pořadí odpovídá chování současné implementace a zatím není verzovanou zárukou.

Před schválením integrace pro produkci musí Parkour Design a partner potvrdit, že se očekávaný objem dat vejde do limitů. Partner, který potřebuje úplné stránkování nebo přírůstkové aktualizace, to nesmí obcházet scrapováním nebo hádáním identifikátorů; vyžaduje to revidovaný kontrakt.

Chybové odpovědi

Chyby používají kompaktní tělo JSON:

{"error": "not_found"}
StavChybaVýznam
401invalid_tokenChybějící, chybně formátovaný, vypršelý, neplatný nebo v současnosti nedostatečně vymezený bearer token
404not_foundNeplatná cesta nebo akce, která není pro uživatele dostupná
405method_not_allowedJiná metoda než GET

Neočekávané chyby služby zatím nemají samostatné verzované schéma chyb. Klienti mají ostatní odpovědi 5xx považovat za opakovatelné jen u idempotentních operací GET, s omezeným exponenciálním odstupem a náhodným rozptylem (jitter).

Data, která API nezpřístupňuje

Souhrn projektu není úplný plán parkuru. Současné API zdrojů nezpřístupňuje:

  • geometrii parkuru ani dráhu;
  • překážky, skupiny, rozmístění kolbiště ani objekty kresby;
  • vytvořená PDF, náhledy, obrázky ani URL ke stažení;
  • operace vytvoření, aktualizace, smazání nebo nahrání;
  • vyhledání jednoho projektu podle jeho ID;
  • webhooky ani tok změn;
  • přístupové tokeny, relace, soutěže, aktivity ani uložené cíle Eqify.

Nepředstavujte odpověď se souhrny jako plán parkuru k tisku nebo úpravám.