Documentation API

La documentation de l'API est en cours de rédaction

Résultats pour l'objet "Jeune-Theatre-National"

Appel de la fonction jQuery

<script type="text/javascript">
    $('#list-spectacles').thnetSpectacles({
        apiRequest: '/api/contacts/OBJET/spectacles/soutien', // Requête (OBJET = identifiant unique) 
	from: '2011-09-01', // Date de début de recherche 
	to: '2012-08-31', // Date de fin de recherche 
	apiKey: 'VOTRE_CLE_API', // Clé API 
	entryPoint: 'https://www.theatre-contemporain.net', // Point d'entrée 
    });
</script>

Les fonctions utilisées sont disponibles sur notre dépôt github

PHP avec cURL

$apiRequest = '/api/contacts/OBJET/spectacles/soutien'; // Requête (OBJET = identifiant unique) 

$from = '2011-09-01'; // Date de début de recherche 

$to = '2012-08-31'; // Date de fin de recherche 

$apiKey = 'VOTRE_CLE_API'; // Clé API 

$entryPoint = 'https://www.theatre-contemporain.net'; // Point d'entrée 
         
// initialiser CURL et définir les options
$apiCall = curl_init($entryPoint.$apiRequest.'?k='.$apiKey);
$apiCallOptions = array(
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => array('Content-type: application/json'),
);
curl_setopt_array($apiCall, $apiCallOptions);
 
// récupèrer les résultats
$result =  json_decode(curl_exec($apiCall));

// faire un print des résultats
echo '<pre>'.print_r($result,true).'</pre>';

Données renvoyées au format JSON

Astuce : pour obtenir un JSON "organisés" pour vos débugages, ajoutez le paramètre ?json_pretty_print ou ?json_pretty_print=JSON_UNESCAPED_SLASHES

Schéma

Array
(
    [properties] => Array
        (
            [title] => Array
                (
                    [type] => string
                    [description] => Titre du spectacle
                )

            [object] => Array
                (
                    [type] => string
                    [description] => Identifiant unique du spectacle
                )

            [permanent_url] => Array
                (
                    [type] => string
                    [description] => URL permanente du spectacle
                )

            [actors] => Array
                (
                    [type] => object
                    [ref] => #person
                    [description] => Distribution
                )

            [directors] => Array
                (
                    [type] => object
                    [ref] => #person
                    [description] => Metteurs en scène
                )

            [authors] => Array
                (
                    [type] => object
                    [ref] => #person
                    [description] => Auteurs du texte associé
                )

            [poster] => Array
                (
                    [type] => string
                    [description] => Affiche du spectacle
                )

            [published] => Array
                (
                    [type] => integer
                    [enum] => Array
                        (
                            [0] => hors ligne
                            [1] => en ligne
                        )

                    [description] => Statut de publication sur theatre-contemporain.net
                )

            [insert_date] => Array
                (
                    [type] => string
                    [description] => Date de création de l'objet éditorial
                )

            [typespectacle] => Array
                (
                    [type] => string
                    [enum] => Array
                        (
                            [0] => mise en scène
                            [1] => mise en espace
                            [2] => lecture
                            [3] => lecture radiophonique
                        )

                    [description] => Type de spectacle
                )

            [near_dates] => Array
                (
                    [type] => object
                    [ref] => #schedules
                    [description] => Période de représentation la plus proche
                )

        )

)