API publique
Les conventions publiées et leur programme, en JSON, pour les afficher sur un agenda, un site de fédération ou le site d’une convention. Sans compte ni clé.
- Lecture seule : rien ne se réserve ni ne se modifie par l’API. Pour réserver, chaque table donne le lien de sa page.
- Rien qui ne soit déjà sur les pages publiques : ni inscrits, ni adresses électroniques, ni brouillons.
- Soixante requêtes par minute et par adresse. Au-delà, la réponse est 429 : attendez une minute.
- Heures à l’heure de Paris. Versionnée : une adresse /v1 ne change pas de forme.
Description OpenAPI (JSON) Elle sert à générer un client automatiquement.
Les conventions à venir
GET /api/v1/conventions
Conventions publiées qui ne sont pas terminées, de la plus proche à la plus lointaine, par pages de 50.
Paramètres
- ville
- string - Partie du nom de la ville.
- du
- date - Conventions qui finissent ce jour-là ou après (AAAA-MM-JJ).
- au
- date - Conventions qui commencent ce jour-là ou avant.
- page
- integer - Numéro de page, à partir de 1.
Champs de chaque objet
- slug
- string - Identifiant stable, à reprendre dans les autres adresses.
- nom
- string - Nom de la convention.
- ville
- string|null - Ville annoncée.
- date_debut
- date - Premier jour, AAAA-MM-JJ, heure de Paris.
- date_fin
- date - Dernier jour.
- heure_ouverture
- string - HH:MM.
- heure_fermeture
- string - HH:MM.
- tarif
- string|null - Texte libre de l’organisateur.
- site_web
- string|null - Adresse du site de la convention.
- tables
- integer - Nombre de tables au programme, annulées exclues.
- liens.page
- url - La page publique.
- liens.programme
- url - Le programme en JSON.
- liens.calendrier
- url - Le programme au format iCalendar.
Exemple
curl "https://www.mon-orga.fr/api/v1/conventions?ville=Nantes"Une convention
GET /api/v1/conventions/{slug}
La fiche d’une convention publiée, avec sa description et ses lieux. Un brouillon ou une convention inconnue répondent 404.
Paramètres
- slug*
- string - Le slug de la convention.
Champs de chaque objet
- slug
- string - Identifiant stable, à reprendre dans les autres adresses.
- nom
- string - Nom de la convention.
- ville
- string|null - Ville annoncée.
- date_debut
- date - Premier jour, AAAA-MM-JJ, heure de Paris.
- date_fin
- date - Dernier jour.
- heure_ouverture
- string - HH:MM.
- heure_fermeture
- string - HH:MM.
- tarif
- string|null - Texte libre de l’organisateur.
- site_web
- string|null - Adresse du site de la convention.
- tables
- integer - Nombre de tables au programme, annulées exclues.
- liens.page
- url - La page publique.
- liens.programme
- url - Le programme en JSON.
- liens.calendrier
- url - Le programme au format iCalendar.
- description
- string|null - Présentation de l’organisateur.
- lieux[].nom
- string - Nom du lieu.
- lieux[].adresse
- string|null - Adresse postale.
- lieux[].latitude
- number|null - Coordonnées, quand l’organisateur les a posées.
- lieux[].longitude
- number|null
- lieux[].accessibilite
- string[] - Codes d’accessibilité du bâtiment.
Exemple
curl "https://www.mon-orga.fr/api/v1/conventions/exemple-de-convention"Le programme d’une convention
GET /api/v1/conventions/{slug}/programme
Toutes les tables non annulées, dans l’ordre du jour et de l’heure. Aucune donnée d’inscrit : seulement ce que montre la page publique.
Paramètres
- slug*
- string - Le slug de la convention.
Champs de chaque objet
- id
- integer - Identifiant de la table.
- numero
- string|null - Numéro affiché sur place.
- jeu
- string - Le jeu.
- jour
- date - AAAA-MM-JJ.
- heure_debut
- string - HH:MM, heure de Paris.
- heure_fin
- string - HH:MM.
- moment
- string - « matin », « apres_midi » ou « soiree ».
- lieu
- string - Lieu et salle.
- mj
- string - Nom du MJ.
- statut
- string - « à_risque », « confirmée » ou « complète ».
- joueurs_min
- integer
- joueurs_max
- integer
- places_restantes
- integer|null - Nul pour une partie ouverte, sans réservation.
- sans_reservation
- boolean - On s’assoit sans réserver.
- debutants_bienvenus
- boolean
- adulte_uniquement
- boolean
- avertissements
- string[] - Codes des avertissements de contenu déclarés.
- lien
- url - La page publique de la table, où l’on réserve.
Exemple
curl "https://www.mon-orga.fr/api/v1/conventions/exemple-de-convention/programme"