API - Guide d'utilisation - v.1.0

Le nouvel annuaire du secteur jeunesse permet désormais non seulement de consulter les informations sur le site même, mais aussi de récupérer et d'utiliser ces informations sur son propre site ou son application iPhone, Android, etc. Le SNJ vous offre ce service dans le but de vous simplifier la maintenance des informations contenues sur votre site. Profitez de la notoriété de l'annuaire du secteur jeunesse et de ses fonctionnalités de gestion par les responsables respectifs des organisations et structures afin d'afficher les informations les plus actuelles sur votre site sans que vous deviez intervenir.

Cette page décrit l'API dans sa version 1.0 qui est dépréciée. Veuillez utiliser la version 1.1!

Extraire du contenu

Tout contenu de l'annuaire peut être consulté par son API. Pour consulter les informations il vous suffit d'envoyer une requête du type

ou format devra être remplacé par un des formats supportés par le système et en fournissant un ou plusieurs des paramètres suivants:

Nom de la variable Type Valeurs permises
content string organisation, structure
region string north, south, east, west, center
radius string voir la liste | consulter l'API
status int voir la liste | consulter l'API
federation int voir la liste | consulter l'API
type int voir la liste | consulter l'API

 

Exemple
http://annuaire.youth.lu/webservice/content.json?content=organisation&region=south&federation=19&radius=local&status=15

Resultat:

Le résultat de votre requête vous sera fourni en format json (javascript object notation) dans ce cas et ressemblera au texte qui suit, issu de la requête ci-dessus. Ce résultat peut contenir un ou plusieurs entités, selon les paramètres que vous avez fournis.

[
{
"titre": "Service National de la Jeunesse",
"address": {
"country": "LU",
"locality": "Luxembourg",
"postal_code": "L - 2330",
"thoroughfare": "138, blvd. de la Pétrusse"
},
"description": "Le Service a pour mission de contribuer à la mise en œuvre de la politique de
 la jeunesse et de constituer un organisme de contact, d’information, de conseil et de soutien
pour les jeunes et les acteurs du travail avec les jeunes.",
"modification_date": "1354720128",
"mobile_phone": [],
"link": "http://www.snj.lu",
"contact": "Réception",
"region": "center",
"fax": "+352 46 41 86",
"phone": "+352 247 86465",
"radius": "national",
"facebook": "http://www.facebook.com/snj.lu",
"googleplus": [],
"twitter": "http://twitter.com/snj_lu",
"affiliation": [],
"label": [],
"logo": "<img typeof=\"foaf:Image\"
src=\"http://annuaire.youth.lu/sites/default/files/organisations/logo/logo-SNJ_carre-textedessous_moyen.png\"
 width=\"339\" height=\"386\" />",
"photo": [],
"members": [
"\n<ul>\n\t \t\t <li><a href=\"/fr/annuaire-personnes/david-raison\">david.raison</a></li>\n\t </ul>\n\n"
],
"people": []
},
[...]
]

Extraire les taxonomies

L'extraction des IDs se fait de façon identique. Pour consulter les informations sur les taxonomies il vous suffit d'envoyer une requête du type

ou format devra être remplacé par un des formats supportés par le système et en fournissant un ou plusieurs des paramètres suivants:

Nom de la variable Type Valeurs permises
vocab_name string federations, statuts, champ_d_action, type_d_organisations (see list)
vocab_id int valeurs numériques qui correspondent aux valeurs ci-dessus (5, 4, 3, 2)

Exemple

En envoyant la requête suivante:

http://annuaire.youth.lu/webservice/taxonomy.json?vocab_name=federations

vous aurez comme réponse la liste de toutes les ID que vous pourrez par la suite utiliser dans la requête des organisations et structures pour le champ federation:

[
    {
        "tname": "EGMJ",
        "tid": "24",
        "vocab_name": "Féderations",
        "vocab_id": "5"
    },
    {
        "tname": "elisabeth",
        "tid": "2424",
        "vocab_name": "Féderations",
        "vocab_id": "5"
    },
    {
        "tname": "Féderation internationale des sociétés magiques (FISM)",
        "tid": "2425",
        "vocab_name": "Féderations",
        "vocab_id": "5"
    },
    {
        "tname": "FNEL",
        "tid": "19",
        "vocab_name": "Féderations",
        "vocab_id": "5"
    },
    {
        "tname": "Lëtzebuerger Guiden a Scouten (LGS)",
        "tid": "27",
        "vocab_name": "Féderations",
        "vocab_id": "5"
    }
]

 

Formats

A cet instant, les formats supportés sont:

format paramètres supplémentaires exemple
json  

[{"titre":"Dippecher Dachsen - FNEL Scouten a Guiden (Dippach)"

jsonp callback=mycallbackfunction

mycallbackfunction([{"titre":"Dippecher Dachsen - FNEL Scouten a Guiden (Dippach)"...

xml    <?xml version="1.0" encoding="utf-8"?><result is_array="true"><item><titre>Dippecher Dachsen - FNEL Scouten a Guiden (Dippach)</titre>
php    a:17:{i:0;O:8:"stdClass":12:{s:5:"titre";s:51:"Dippecher Dachsen - FNEL Scouten a Guiden (Dippach)"

 

 

Index des applications

Si vous utilisez notre API pour afficher des données de l'annuaire sur votre site ou que vous avez écrit une application smartphone, un plugin pour wordpress, drupal ou autre, faites le nous savoir et on pourra le publier sur ce site.

Détail Capture d'écran
Annuaire Client Wordpress Plugin  
Un plugin pour Wordpress qui fonctionne avec des "shortcodes" et vous permet d'afficher les données sélectionnées de l'annuaire directement sur votre site.
L'affichage peut se faire sous forme d'une liste ou d'une carte géographique et fonctionne également comme widget.
Download depuis github.

v.1.1