Menu de la documentation
Selon le partenaire Dernière mise à jour: 27 juillet 2026

Échange de données

Utilisez les ressources partenaires actuelles en lecture seule et définissez un contrat sûr pour l’échange de plans de parcours propre à chaque partenaire.

Parkour Design expose actuellement un service de ressources coordonné, en lecture seule, pour les résumés des événements et des plans de parcours. La géométrie complète des projets, les fichiers, l’écriture et la synchronisation nécessitent un contrat partenaire distinct.

État du contrat : les points de terminaison ci-dessous décrivent le comportement actuellement déployé pour les clients approuvés. Ce n’est pas encore une API générale versionnée. Ne développez pas contre eux avant que Parkour Design ait confirmé l’accès, les scopes, les limites et le contrat de lancement.

URL de base et authentification

Utilisez l’émetteur choisi pour l’environnement OAuth comme URL de base de l’API :

EnvironnementURL de base
Productionhttps://app.parkour.design
Testhttps://parkour-test.web.app

Envoyez le jeton d’accès Parkour Design depuis un service serveur :

Authorization: Bearer <access_token>
Accept: application/json

Le jeton d’accès doit être valide pour l’émetteur configuré et l’audience parkour-api, avoir un token_use égal à access_token et contenir actuellement openid.

L’API ne permet pas actuellement l’accès depuis un navigateur d’une autre origine. N’exposez pas le jeton d’accès ni le jeton de rafraîchissement au JavaScript côté client.

Lister les événements

GET /api/events

Exemple de requête :

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

Exemple de réponse :

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

Type de réponse actuel :

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

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

Les événements sont constitués à partir des projets non supprimés de l’utilisateur authentifié. Les projets sans identifiant d’événement sont ignorés.

Considérez id comme opaque. Recopiez-le tel quel dans la requête des résumés de projets. N’en déduisez pas le format et ne le générez pas dans le système partenaire.

Lister les résumés de projets d’un événement

GET /api/events/{eventId}/designs

Exemple de requête :

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

Exemple de réponse :

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

Type de réponse actuel :

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

Les dates, quand elles sont présentes, sont des chaînes ISO 8601 en UTC. Les clients doivent accepter null pour les dates facultatives et pour localId.

Propriété et visibilité

Le sub du jeton porteur identifie le propriétaire des ressources Parkour Design. Les réponses ne contiennent que les projets non supprimés appartenant à cet utilisateur.

Le service actuel ne fournit pas :

  • d’accès à l’échelle d’une organisation ou d’une équipe ;
  • d’accès aux projets partagés ou publics d’un autre utilisateur ;
  • de filtrage des ressources propre à un client ;
  • les projets supprimés ;
  • de données d’abonnement, de profil ou de paiement.

Un événement inexistant et un événement appartenant à un autre utilisateur renvoient tous deux 404. N’utilisez pas cette réponse pour en déduire l’existence de la ressource d’un autre utilisateur.

Limites actuelles et ordre

Les points de terminaison actuels n’acceptent aucun paramètre de filtrage, de tri, de pagination, de curseur ou de synchronisation incrémentale.

  • /api/events renvoie la liste des événements en une seule réponse.
  • /api/events/{eventId}/designs renvoie au maximum 500 résumés.
  • La réponse n’indique pas actuellement de troncature et ne fournit pas de curseur de continuation.
  • L’ordre correspond au comportement actuel de la mise en œuvre et n’est pas encore une garantie versionnée.

Avant de valider une intégration en production, Parkour Design et le partenaire doivent confirmer que le volume de données attendu respecte ces limites. Un partenaire qui a besoin d’une pagination complète ou de mises à jour incrémentales ne doit pas compenser en aspirant les données ou en devinant des identifiants : cela nécessite un contrat révisé.

Réponses d’erreur

Les erreurs utilisent un corps JSON compact :

{"error": "not_found"}
StatutErreurSignification
401invalid_tokenJeton porteur absent, mal formé, expiré, invalide ou aux scopes actuellement insuffisants
404not_foundRoute invalide ou événement non accessible à cet utilisateur
405method_not_allowedMéthode autre que GET

Les défaillances inattendues du service n’ont pas encore de schéma d’erreur versionné à part. Les clients ne doivent considérer les autres réponses 5xx comme réessayables que pour les opérations GET idempotentes, avec un délai exponentiel borné et une part d’aléatoire.

Données non exposées par cette API

Le résumé d’un projet n’est pas un plan de parcours complet. L’API de ressources actuelle n’expose pas :

  • la géométrie ou le tracé du parcours ;
  • les obstacles, groupes, disposition de la carrière ou objets de dessin ;
  • les PDF générés, aperçus, images ou URL de téléchargement ;
  • les opérations de création, de modification, de suppression ou d’envoi ;
  • la recherche d’un projet par son identifiant ;
  • les webhooks ou un flux de modifications ;
  • les jetons d’accès, sessions, épreuves, activités ou destinations enregistrées d’Eqify.

Ne présentez pas un résumé comme un plan de parcours imprimable ou modifiable.