Introduction

Jeu de caractères

L'API DVDFr utilise des flux XML encodés en UTF-8. Toutes les requêtes doivent-être encodées dans ce même jeu de caractères.

Requêtes HTTP / User Agent

Les appels à l'API doivent-être fait avec un USER_AGENT propre à votre logiciel. DVDFr se réserve la possibilité de filtrer les USER_AGENT génériques (vides ou correspondant à un navigateur ou une API HTTP générique).

Erreurs

Les erreurs sont renvoyées sous forme de flux XML. La structure de ces messages d'erreur est toujours la suivante :

<errors>
	<error type="[fatal|warning]">
		<code>CODE_ERREUR</code>
		<message>Message d'erreur</message>
	</error>
</errors>

Recherche


Fiche

Présentation

Cette API vous permet de récupérer les spécifications techniques d'un DVD (ou UMD / Blu-ray, etc.).

L'utilisation de cette API est limitée par un système de quotas (cf. utilisation des quotas). Le quota actuel est de 200 fiches par semaines. Il est possible de réinitialiser ce quota 5 fois. Tout appel à l'API fiche compte pour une utilisation de ce quota. Nous vous déconseillons donc d'appeler l'API fiche pour chaque résultat de recherche.

Adresse

http://www.dvdfr.com/api/dvd.php

Paramètres

Paramètre Type Description
id Obligatoire Identifiant DVDFr de la fiche à récupérer.
bandeAnnonce Facultatif Si ce paramètre est positionné renvoit les informations sur les bandes-annonces (URL, identifiant, etc.). Ne fonctionne que pour les appels signés à l'API.
json Facultatif / expérimental Si ce paramètre est positionné, le résultat de l'appel à l'API sera renvoyé sous la forme d'un objet JSON au lieu d'un flux XML
ts Facultatif Utilisé pour les appels signés à l'API.
Timestamp unix au moment où vous faites l'appel à l'API.
key Facultatif Utilisé pour les appels signés à l'API. Nous contacter pour plus d'information à ce sujet.

Résultats obtenus

Vous obtenez un flux XML avec l'ensemble des caractéristiques techniques de la fiche. Ce flux n'est pas (encore) documenté ici-même mais devrait se suffire à lui-même. Sinon n'hésitez pas à contacter le responsable technique du site pour plus de renseignements.


Quotas

Présentation

Cette API permet de connaitre l'utilisation qui est faite de son quota d'appels à l'API fiche.

Adresse

http://www.dvdfr.com/api/quota.php

Paramètres

Paramètre Type Description
xml Facultatif Récupération du résultat sous forme API au format XML
json Facultatif Récupération du résultat sous forme API au format JSON
ts Facultatif Utilisé pour les appels signés à l'API.
Timestamp unix au moment où vous faites l'appel à l'API
key Facultatif Utilisé pour les appels signés à l'API. Nous contacter pour plus d'information à ce sujet. Utiliser 0 comme valeur d'ID pour signer vos appels.

Pour récupérer les quotas dans un format exploitable par vos programmes, vous devez spécifier soit xml soit json dans votre appel à cette API

Résultats obtenus

Vous obtenez sous forme XML les informations d'utilisation de votre quota. Vous ne pouvez pas utiliser l'API pour demander la remise à zéro de votre quota, il faut passer par le formulaire sur le site. L'adresse du formulaire est présente dans le flux de résultat :

<quotas generator="$Revision: 1360 $">
    <fetchs>
        <used>2</used>
        <maximum>200</maximum>
    </fetchs>
    <resets>
        <used>0</used>
        <maximum>3</maximum>
        <url>http://www.dvdfr.com/api/quota.php</url>
    </resets>
</quotas>

Ce flux est composé de deux informations : la première est liée au nombre d'appels effectués à l'API fiche (<fetchs>) et aux remises à zéro possible (<resets>). Chaque information est décomposée en nombre d'appels effectués (<used>) et en nombre d'appels maximum effectuables (<maximum>). L'URL permettant d'accéder au formulaire de réinitialisation des quotas est aussi donnée dans le flux.


Liste de produits

API PRO uniquement. Cette API n'est utilisable que pour les abonnés pro aux API DVDFR. Pour vous abonner voir la page contact du site.

Cette API permet via un seul appel de recevoir les résultats pour plusieurs EAN en une seule fois. Vous consommez une unité de quota pour chaque EAN fourni en paramètre existant dans notre base. Si un EAN est invalide, une erreur est renvoyée par l'API.

Adresse

http://www.dvdfr.com/api/productlist.php

Méthode d'appel : GET

Paramètres

Paramètre Type Description
ean[] Obligatoire Liste des EAN à interroger
bandeAnnonce Facultatif Si ce paramètre est positionné renvoit les informations sur les bandes-annonces (URL, identifiant, etc.).
json Facultatif / expérimental Si ce paramètre est positionné, le résultat de l'appel à l'API sera renvoyé sous la forme d'un objet JSON au lieu d'un flux XML
ts Obligatoire Timestamp unix au moment où vous faites l'appel à l'API
key Obligatoire Pour calculer votre clé, remplacer l'ID par la concaténation des EAN séparés par des ,

Résultats obtenus

Vous obtenez une liste de produits. Chaque produit est conforme à la spécification individuelle de l'API dvd décrite précédemment.


Quotas

Présentation

Cette API permet de connaitre l'utilisation qui est faite de son quota d'appels à l'API fiche.

Adresse

http://www.dvdfr.com/api/quota.php

Paramètres

Paramètre Type Description
xml Facultatif Récupération du résultat sous forme API au format XML
json Facultatif Récupération du résultat sous forme API au format JSON
ts Facultatif Utilisé pour les appels signés à l'API. Nous contacter pour plus d'information à ce sujet.
key Facultatif Utilisé pour les appels signés à l'API. Nous contacter pour plus d'information à ce sujet. Utiliser 0 comme valeur d'ID pour signer vos appels.

Pour récupérer les quotas dans un format exploitable par vos programmes, vous devez spécifier soit xml soit json dans votre appel à cette API

Résultats obtenus

Accès Rapide

(publicité)

(publicité)