Home

ginger-client est un client PHP pour ginger, l'outil cotisant du BDE-UTC.

Pour l'utiliser, vous avez besoin d'une clé d'API, qui doit être demandée par mail à [email protected], en précisant le nom de l'asso, les données nécessaires et les modalités dans lesquelles elles seront utilisées (éventuelles copies locales et durée de conservation dans ce cas).

La dernière version est téléchargeable sur ce lien.

Si vous utilisez git pour votre projet, il est plutôt conseillé d'ajouter git://github.com/simde-utc/ginger-client.git comme submodule.

Si vous utilisez déjà Composer, vous pouvez également demander l'installation du package ginger/client.

Voici un exemple d'affichage de l'adresse mail correspondant au login puyouart :

<?php
// Charger ginger (pas nécessaire si vous utilisez Composer)
require("ginger-client/autoload.php");

try {
    $ginger = new Ginger\Client\GingerClient("MaSuperCléSecrète");
    $user = $ginger->getUser("puyouart");
    echo $user->mail;
}
catch (Ginger\Client\ApiException $ex){
    echo "Impossible de trouver l'utilisateur, erreur ".$ex->getCode();
}

Les champs disponibles (sur l'objet $user dans l'exemple) sont :

• login : login
• nom et prenom : nom de famille et prénom
• mail : adresse mail (au format prenom.nom et avec le bon domaine !)
• type : etu pour étudiant UTC, pers pour personnel UTC, escom pour étudiant ESCOM, escompers pour personnel ESCOM ou bien ext pour cotisant extérieur
• is_adulte : vrai si l'utilisateur a plus de 18 ans
• is_cotisant : vrai si l'utilisateur a une cotisant active au BDE (toujours vrai pour le personnel, qui est membre d'honneur)

Les champs suivants nécessitent une autorisation supplémentaire :

• badge_uid : UID Mifare du badge de l'utilisateur
• expiration_badge : date d'expiration du badge de l'utilisateur

Il existe également des méthodes pour l'affichage du détail des cotisations, ou la modification des données, mais elles ne seront probablement pas utilisées par d'autres associations que le BDE.