Interface de programmation (API) BETA

Nous mettons à diposition des salles de spectacles une API permettant d'afficher les photos en temps réel sur leurs propres site.

Cette documentation vous aidera à mettre en place rapidement ce service sur votre site. Si vous rencontrez des difficultés, merci de me contacter…

Ce projet en en cours de mise en place (Beta), les spécifications peuvent encore bouger et il faut encore un certains temps pour référencer toutes les photos… Ne vous inquiétez pas si vous ne pouvez accédez à des albums… Les URL d'exemples fonctionnent, n'hésitez pas à vous en servir pour réaliser des essais !

Construction de l'URL

Pour pouvoir définir quels seront les photos reçus, vous devez construire une adresse à questionner. Cette adresse se constitue des éléments suivants :

  • le [site] de l'auteur
  • le [lieu], nom de la salle de spectacle, en toutes lettres et en remplacant les espaces par _
  • la [date], aux formats AAAA, AAAAMM ou AAAAMMJJ

Grace à ces éléments, nous allons construire l'adresse de cette manière : http://[site]/API/[lieu]/[date]

Exemples

http://www.clovis-gauzy.fr/API/Le_Florida retournera toutes les photos réalisés au Florida

http://www.clovis-gauzy.fr/API/Le_Florida/2009 retournera toutes les photos réalisés au Florida en 2009

http://www.clovis-gauzy.fr/API/Le_Florida/200912 retournera toutes les photos réalisés au Florida en décembre 2009

http://www.clovis-gauzy.fr/API/Le_Florida/20091216 retournera toutes les photos réalisés au Florida le 16 décembre 2009

http://www.clovis-gauzy.fr/API/Le_Florida/random retournera une photo au hasard réalisée au Florida

http://www.clovis-gauzy.fr/API/Le_Florida/2009/random retournera une photo au hasard réalisée au Florida en 2009

http://www.clovis-gauzy.fr/API/Le_Florida/200912/random retournera une photo au hasard réalisée au Florida en décembre 2009

http://www.clovis-gauzy.fr/API/Le_Florida/20091216/random retournera une photo au hasard réalisée au Florida le 16 décembre 2009

Informations de retour

La réponse est retourné sous la forme d'un tableau PHP mis en série (il suffit d'un unserialize() pour lui redonner sa vrai nature)

Il aura deux formes différente selon que vous ayez demandé une image aléatoire ou des galeries

Réponse pour les galeries

  • [x] (numéro d'incrémentation)
    • [titre] => de la galerie
    • [date] => au format timestamp
    • [lieu] =>
    • [photos]
      • [x] => référence de la photo
    • [categorie] =>
    • [short] => URL courte de la galerie sur le site de l'auteur

Réponse pour la photo aléatoire

  • [titre] =>
  • [ref] =>
  • [date] => au format timestamp
  • [lieu] =>
  • [short] => URL courte de la photo sur le site de l'auteur

Les modules prêt à porter

Pour le moment, nous ne proposons que des solutions pour des sites supportant le PHP et permettant l'utilisaton de cURL ou files_get_contents()

PHP

Code à rajouter entre les bannières et de chaque page…

…ou directement dans le fichier CSS de votre thème (n'hésitez par à adapter)

Code à rajouter sur chaque page qui va exploiter l'API. Il est fortement conseillé de mettre ce code dans un fichier à part et de l'appeler ensuite avec un require_once() ou de l'intégré dans un fichier qui sera appelé pour chaque page.

Il suffit maintenant d'insérer cette commande avec l'URL que l'on aura construit plus haut (ici la galerie du 16 décembre 2009 au Florida)

Si vous avez des propositions pour améliorer / optimiser ce code, n'hésitez pas à m'en faire part ! ^^


À propos...