API - Guide d'utilisation - v.1.2

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.2. L'ancienne version 1.1 est toujours disponible. 

 

Extraire du contenu

Tout contenu de l'annuaire peut être consulté en consultant notre service REST. Contrairement à la version 1.0, l'accès aux données par l'API dans sa version 1.1 se fait par des chemins spécifiques. Voici les différents types disponibles et leurs URI ou format devra être remplacé par un des formats supportés par le système:

Type URI
organisations https://annuaire.youth.lu/api/v1.2/organisations.format?
structures https://annuaire.youth.lu/api/v1.2/structures.format?

 

Formats

A cet instant, les formats supportés pour tout type de contenu 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)"

 

Filtres

En dehors du format, vous pouvez restreindre le nombre de résultats que vous recevez en spécifiant un ou plusieurs paramètres. Les paramètres suivants sont disponibles en fonction du type de contenu que vous consultez:

Nom de la variable Type Valeurs permises Disponible pour le contenu du type
region string north, south, east, west, center organisations, structures
radius string voir la liste | consulter l'API organisations
status int voir la liste | consulter l'API organisations
federation int voir la liste | consulter l'API organisations
type int voir la liste | consulter l'API organisations, structures
city string toutes (p.ex. "Senningen") structures
label_id int 270 (Proufsall)
271 (Tounstudio)
1561 (Jugendinfo)
structures
organisation_id int ... structures

 

Exemple

Pour consulter les informations sur des organisations qui sont du type "administration de l'Etat" et agissent au niveau local, il vous suffit d'envoyer une requête comme la suivante :

https://annuaire.youth.lu/webservice/organisations.json?region=center&radius=national&type=6

Vous pouvez voir le résultat dans votre navigateur en cliquant sur le lien ci-dessus.

Resultat:

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

[
...
{
"id": "355",
"title": "Service National de la Jeunesse",
"status": "Service de l&#039;Etat",
"image": "http://annuaire.youth.lu/sites/default/files/styles/medium/public/organisations/logo/logo-SNJ_carre-textedessous_moyen.png",
"address": {
"country": "LU",
"locality": "Luxembourg",
"postal_code": "2330",
"thoroughfare": "138, blvd. de la Pétrusse"
},
"coordinates": "49.6048, 6.13236",
"geojson": "{"type":"Point","coordinates":[6.1323654,49.6048424]}",
"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": "1366262535",
"mobile_phone": [],
"contact": "Secretariat",
"region": "center",
"fax": "+352 46 41 86",
"phone": "+352 247 86460",
"radius": "national",
"website": "http://www.snj.lu",
"facebook": "http://www.facebook.com/snj.lu",
"googleplus": [],
"twitter": "http://twitter.com/snj_lu",
"members": [
"\n<ul>\n\t \t\t <li><a href=\"/fr/annuaire-personnes/eric-krier\">eric.krier</a></li>\n\t </ul>\n\n",
"\n<ul>\n\t \t\t <li><a href=\"/fr/annuaire-personnes/david-raison\">david.raison</a></li>\n\t </ul>\n\n",
"\n<ul>\n\t \t\t <li><a href=\"/fr/annuaire-personnes/cliff-hever\">cliff.hever</a></li>\n\t </ul>\n\n"
]
},
...
]

Problèmes connus

Les problèmes suivants sont actuellement connus:

Champ Problème
members Les balises HTML ne sont pas retirées de l'export.
people Les balises HTML ne sont pas retirées de l'export.

 

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:

https://annuaire.youth.lu/api/v1.2/taxonomy.json?vocab_name=federations

vous aurez comme réponse la liste de toutes les ID (tid) 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"
    }
]

En dehors de l'utilisation de l'API, il existe aussi une liste des valeurs disponibles.

 

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 (v1.0 de l'API pour l'instant uniquement)
 false
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