L'API Hellotipi : bienvenue chez les barbus

Hello World !

Bonjour et bienvenue dans la documentation de l'API Hellotipi.
Ici tout n'est que technique, code source et volupté.
L'équipe d'Hellotipi adoooore jouer avec les cubes des autres, c'est donc tout naturellement que nous avons voulu mettre en place notre propre API.

Vous l'aurez compris cette page s'adresse avant tout à ceux (et celles ?) qui souhaitent créer des outils amusants grâce à leur site de famille.
Si vous vous sentez l'âme d'un bidouilleur de l'extrême mais que votre contrôleur fiscal vous refuse l'achat d'un site Hellotipi: envoyez-nous un email et nous ferons tout pour corriger rapidement cette injustice.

Vous trouverez ci-dessous la documentation des fonctions de notre API.
Si vous avez des remarques, des questions, des fleurs ou des gueulantes à nous envoyer n'hésitez pas à le faire nous adorons ça :

Sauvez l'univers sans tuer le moindre martien

Imprimer cette documentation n'est pas forcément une bonne idée (en plus le papier n'est pas mis à jour contrairement à cette page)

Généralités

L'url de l'API est de la forme
http://www.hellotipi.com/?page=api&action=NOM_DE_LA_FONCTION

La plupart des fonctions de l'API nécessitent d'être authentifié avec un compte Hellotipi valide (vous pouvez en créer un gratuitement à cette adresse)

La connexion est faite via le système de HTTP Basic Authentication.

Les réponses de l'API se font en UTF-8
Par défaut au format JSON.
Pour récupérer les résultats au format XML il suffit de rajouter "&format=xml" dans l'url

Fonctions globales

site_list

Description

Permet de récupérer la liste des sites auquel l'utilisateur est inscrit.

URL

http://www.hellotipi.com/?page=api&action=site_list

Paramètre(s)

aucun

Réponse

Tableau, "x" étant le numéro de ligne (compris entre 0 et le nombre de sites - 1)

[x]['name'] = char (nom du site)
[x]['role'] = char (rôle du user sur ce site: "webmaster" ou "user")

Exemple

http://www.hellotipi.com/?page=api&action=site_list
Retourne la liste des sites de famille auquel l'utilisateur est inscrit.

Fonctions albums photos et vidéos

last_pic_list

Description

Permet de récupérer la liste des nb_pic dernières photos ajoutées aux sites auquel l'utilisateur est inscrit.

URL

http://www.hellotipi.com/?page=api&action=last_pic_list

Paramètre(s)

nb_pic = int (nombre max de photos à retourner par site, entre 1 et 20, facultatif, 10 par défaut)

Réponse

Tableau trié par date de publication de photo décroissante, "x" étant le numéro de ligne (compris entre 0 et le nombre de résultats - 1)

[x]['site_name'] = char (nom du site où se trouve la photo)
[x]['picture_url'] = char (url où visionner l'image dans le site de famille)
[x]['small_url'] = char (url de la photo en miniature 100x100 px)

Exemple

http://www.hellotipi.com/?page=api&action=last_pic_list&nb_pic=5
Retourne la liste des 5 dernières photos ajoutées aux sites de famille auquel l'utilisateur est inscrit.

album_list

Description

Permet de récupérer la liste des albums d'un site donné (auquel l'utilisateur est inscrit).

URL

http://www.hellotipi.com/?page=api&action=album_list

Paramètre(s)

site_name = char (nom du site, obligatoire)

Réponse

Tableau trié dans le même ordre que sur le site de famille, "x" étant le numéro de ligne (compris entre 0 et le nombre de résultats - 1)

[x]['id'] = int (id de l'album)
[x]['name'] = char (nom de l'album)

Exemple

http://www.hellotipi.com/?page=api&action=album_list&site_name=nom2famille
Retourne la liste des albums du site "nom2famille".

random_pic

Description

Retourne une image au hasard parmi celles des albums des sites auxquels l'utilisateur est inscrit.

URL

http://www.hellotipi.com/?page=api&action=random_pic

Paramètre(s)

aucun

Réponse

Tableau avec les informations concernant la photo

['id_photo'] = int (id de la photo)
['site_name'] = char (nom du site d'où vient la photo)
['picture_url'] = char (url où visionner l'image dans le site de famille)
['small_url'] = char (url de la photo en miniature 100x100 px)
['medium_url'] = char (url de la photo en format "écran": 800px max en hauteur ou en largeur)

Exemple

http://www.hellotipi.com/?page=api&action=random_pic
Retourne une image au hasard parmi celles des albums des sites auxquels l'utilisateur est inscrit.

Fonctions agenda

calendar_select

Description

Permet de récupérer la liste des évènements (entre 2 dates) d'un site auquel l'utilisateur est inscrit.

URL

http://www.hellotipi.com/?page=api&action=calendar_select

Paramètre(s)

site_name = char (nom du site, obligatoire)
date_a = char (date de début de la période, format AAAA-MM-JJ, obligatoire)
date_a = char (date de fin de la période, format AAAA-MM-JJ, obligatoire)

Réponse

Tableau, "x" étant le numéro de ligne (compris entre 0 et le nombre d'évènements - 1)

[x]['date'] = char (date de l'évènement, format AAAA-MM-JJ)
[x]['type'] = char (type d'évènement: "birthday" ou "event")
[x]['content'] = char (détails de l'évènement, pour les anniversaires il s'agit du prénom et du nom de la personne)

Exemple

http://www.hellotipi.com/?page=api&action=calendar_select&site_name=nom2famille&date_a=2007-12-21&date_b=2008-12-21
Retourne la liste des évènements du site "nom2famille" entre le 21 décembre 2007 et le 21 décembre 2008.

Fonctions messages textes

Bientôt.