Documentation API

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

Résultats pour l'objet "Theatre-National-De-La-Colline"

Appel de la fonction jQuery

<script type="text/javascript">
    $('#list-spectacles').thnetVideos({
        apiRequest: '/api/contacts/OBJET', // Requête (OBJET = identifiant unique) 
	start: '0', // Debut de l'offset 
	end: '5', // Fin de l'offset 
	apiKey: 'VOTRE_CLE_API', // Clé API 
	entryPoint: 'https://www.theatre-video.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'; // Requête (OBJET = identifiant unique) 

$start = '0'; // Debut de l'offset 

$end = '5'; // Fin de l'offset 

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

$entryPoint = 'https://www.theatre-video.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
(
    [type] => object
    [properties] => Array
        (
            [title] => Array
                (
                    [type] => string
                    [description] => Titre de la vidéo
                )

            [object] => Array
                (
                    [type] => string
                    [description] => Identifiant unique de la vidéo
                )

            [permalink] => Array
                (
                    [type] => string
                    [description] => URL permanente de la vidéo
                )

            [duration] => Array
                (
                    [type] => integer
                    [description] => Durée de le vidéo
                )

            [quality] => Array
                (
                    [type] => integer
                    [enum] => Array
                        (
                            [0] => basse qualité (vidéo ancienne)
                            [1] => bonne qualité
                        )

                    [description] => Qualité de l'enregistrement
                )

            [language] => Array
                (
                    [type] => string
                    [description] => Langue de la vidéo
                )

            [description] => Array
                (
                    [type] => string
                    [description] => Texte de présentation de la vidéo
                )

            [capture_date] => Array
                (
                    [type] => string
                    [description] => Date d'enregistrement de la vidéo
                )

            [actors] => Array
                (
                    [type] => object
                    [ref] => #person
                    [description] => Acteurs associés à la vidéo (présents sur la vidéo)
                )

            [directors] => Array
                (
                    [type] => object
                    [ref] => #person
                    [description] => Metteurs en scène associés à la vidéo
                )

            [authors] => Array
                (
                    [type] => object
                    [ref] => #person
                    [description] => Auteurs associés à la vidéo
                )

            [partners] => Array
                (
                    [type] => object
                    [ref] => #contact
                    [description] => Partenaires associés à la vidéo
                )

            [spectacles] => Array
                (
                    [type] => object
                    [ref] => #spectacle
                    [description] => Spectacles associés à la vidéo
                )

            [thumbnail] => Array
                (
                    [type] => string
                    [description] => URL vers la vignette de la vidéo
                )

            [image] => Array
                (
                    [type] => string
                    [description] => URL vers l'image grande taille de la vidéo
                )

            [player] => Array
                (
                    [type] => string
                    [description] => Code d'intégration HTML5
                )

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

        )

)