Home > Dev

Dev

March 24th, 2013

Si vous êtes développeur et que vous souhaitez contribuer au projet Fihirana Online, n’hésitez pas à nous contacter.

APIs de Fihirana Online

Fihirana Online met à la disposition de tous les technophiles un ensemble d’APIs permettant de récupérer les chants du Fihirana programmatiquement.

API de récupération des chants

Cette API permet de récupérer le contenu des chants.

$BASE_URL = http://fihirana.org/wp-content/plugins/fihirana/api/post.php?

Toutes les méthodes utilisent des arguments HTTP standards (?var1=valeur&var2=valeur2 …) et ces arguments sont :

  • d : data source
  • da : data source argument
  • r : renderer
  • ra : renderer argument

Les valeurs des ces arguments sont eux même spécifiques aux data sources choisis et sont encodés par “url-encode”.

Data sources

Il existe deux manière de rechercher les chants : soit en recherche textuelle, soit en spécifiant un ou plusieurs Ids (recherche multiple)

TextSearch API

Cette data source permet de faire des recherches textuelles dans le fihirana. Si vous mettez une valeur vide à ‘q’, vous obtiendrez la liste exhaustive des chants. Le paramètre ’l’ permet de limiter le nombre d’éléments retournés.
Arguments:

  • q=XXX (text filter)
  • l=999 (max item count)

Exemple :
$BASE_URL?d=textsearch&da=q%3Dnoely%26l%3D10&r=html

IdSearch

Cette data source permet d’obtenir quelques chants dont on connait l’ID. Les ID sont expliqués sur la page de recherche multiple.

Exemple :
Pour récupérer le chant FFPM 427 : 
$BASE_URL?d=idsearch&da=427&r=html

Renderer

Le rendu du resultat peut se faire sous plusieurs formats. Le plus courant étant ‘Json’, mais vous avez surement remarqué que dans les exemples ci dessous, il est possible d’utiliser le rendu ‘html’

Rss

- r=rss

Json

- r=json

Xml

- r=xml

pdf

- r=Pdf

html

- r=html