API theatre-contemporain.net et theatre-video.net
fonctionnement → fonctionnement commun à toutes les API
valable pour theatre-contemporain.net theatre-video.net
Obtenir une clé API
Pour obtenir gratuitement une clé d'accès à l'API, vous devez posséder un compte mon théâtre et valider les conditions générales d'utilisation.
Point d'entrée
- Le point d'entrée de l'API theatre-contemporain.net est
https://www.theatre-contemporain.net/api/(http ou httpS) - Le point d'entrée de l'API theatre-video.net est
https://www.theatre-video.net/api/(http ou httpS)
Types d'objets éditoriaux
Plusieurs types d'objets éditoriaux sont accessibles par le biais de l'API :
contacts: les structures (rubrique « Théâtre et cie. » du site)spectacles: les spectacles (rubrique « Spectacles » du site)persons: les artistes (auteurs, metteurs en scène, traducteurs, acteurs, techniciens...), les éditeurs...texts: les textes (rubrique édions)videos: les documents vidéos
Ces objets éditoriaux peuvent apparaître ensemble dans une requête.
Ainsi, à titre d'exemple, un objet contacts pourra être associée à ces différents type de données spectacles, texts et vice et versa
Identification d'un objet
Chaque objet d'un type est identifié par une clé unique. Dans la documentation de l'API, {OBJET} correspond à cette clé. Il s'agit de la dernière partie de l'URL simplifiée de l'objet.
Par exemple, pour le spectacle Le
Plancher des Vaches dont l'URL permanente est
https://www.theatre-contemporain.net/spectacles/Le-Plancher-des-vaches/
l'identifiant de l'objet est Le-Plancher-des-vaches
Autre exemple, pour l'auteur Jean-Luc Lagarce, dont l'URL permanente
est https://www.theatre-contemporain.net/biographies/Jean-Luc-Lagarce/,
l'identifiant de l'objet est Jean-Luc-Lagarce
Les caractères spéciaux sont remplacés par des caractères simples et les espaces remplacés par des tirets.
Formats de sortie
Plusieurs formats de sorties sont disponibles mais merci de privilégier l'extraction des données au format JSON
Les formats disponible sont
- JSON (par défaut) et JSONP (fonction de callback libre) / paramètre :
f=json - XML / paramètre :
f=xml
Utilisation de la clé API
Le paramètre k=VOTRE_CLÉ doit-être ajouté à la fin de l'appel
Codes de statut renvoyés
| Code | Statut | Détail |
|---|---|---|
| 200 | OK | Réponse correcte (rock & roll !) |
| 401 | Unauthorized | Erreur d'authentification : la clé n'est pas valide ou n'est pas précisée |
| 400 | Bad Request | Un ou plusieurs paramètres ne sont pas correctement précisés |
| 404 | Not Found | La ressource est introuvable ou la requête ne renvoi pas de résultat |
Rafraîchissement des données
Les données sont mises à jour toutes les heures.