Skip to content

Conventions de l'API ​

L'API Mitoera est une API REST : des URLs de ressources, des verbes HTTP, du JSON dans les deux sens.

https://api.mitoera.com/api

Authentification ​

Authentification HTTP Basic, keyId en identifiant et secret en mot de passe.

http
Authorization: Basic {base64(keyId:secret)}
bash
curl https://api.mitoera.com/api/charts \
  -u pk_xxxxxxxx:sk_xxxxxxxx

Les endpoints de cette référence exigent tous une clé secrète. La clé publique ne sert qu'au widget, qui appelle des routes /api/widget/** dédiées. Voir Clés API.

Environnements ​

Une seule URL pour les deux environnements : c'est le préfixe de la clé qui décide.

CléInstance
pk_live_…Production
pk_test_…Sandbox

Voir Mode sandbox.

Format des échanges ​

Requêtes — corps en JSON, avec Content-Type: application/json pour tout POST, PUT et PATCH.

Réponses — toujours du JSON. Un objet pour une ressource, un tableau pour une collection.

Identifiants — des UUID sous forme de chaînes : 01926a3f-1234-7abc-8def-000000000001. Les événements ont en plus un identifier textuel unique.

Dates — format ISO 8601 UTC : 2025-01-15T10:00:00Z.

Verbes utilisés ​

VerbeUsage
GETLire une ressource ou une collection
POSTCréer, ou déclencher une action (/publish, /hold, /book)
PUTRemplacer les champs d'une ressource
PATCHModifier partiellement (statuts de sièges)
DELETESupprimer

Erreurs ​

Le code HTTP porte le sens, le corps porte le message :

json
{
  "error": "Le nom est requis"
}

Le tableau complet est sur Codes d'erreur.

Périmètre d'une clé ​

Une clé appartient à un workspace, et ne voit que les ressources de ce workspace. Aucun paramètre workspaceId à passer : le filtrage est implicite. Tenter d'atteindre une ressource d'un autre workspace renvoie 403, jamais 404 — la distinction évite de deviner l'existence de ressources voisines.

Les ressources ​

RessourceCe qu'elle représentePage
PlansLa carte d'une salle et ses siègesPlans
ÉvénementsUne date sur un planÉvénements
RéservationsLe cycle hold → book → releaseRéservations
CatégoriesTarifs et zonesCatégories

Plutôt qu'écrire ces appels à la main

Les SDK enveloppent tous ces endpoints avec des objets typés et gèrent l'authentification pour vous.

API, SDK et widget de plans de salle.