LeMaitre4523 / pix-api

Un simple module capable d'interagir avec le service français Pix
GNU General Public License v3.0
0 stars 0 forks source link
javascript pix pix-api wrapper wrapper-api

Pix API

Un simple module capable d'interagir avec le service français Pix.

Features

Installation

  npm i pix-api-client

Exemples

const PIX = require("pix-api-client");
const pix = new PIX();

//Connexion avec des identifiants
await pix.loginWithCredentials("username", "password");

//Connexion avec des tokens
await pix.loginWithTokens("userId", "access_token", "refresh_token");

//Vous avez le choix entre révoquer seulement un token (access_token ou refresh_token) ou alors les deux
await pix.revokeTokens({
    access_token: "test", //refresh_token: "test"
});

await pix.revokeTokens();

//Obtenir les informations de l'utilisateur
pix.getUser();

//Obtenir ses certifications
pix.getCertifications().then(certifications => {

})

//Obtenir les compétences de l'utilisateur
pix.getCompetences().then(profile => {
    /*
    {
        global: {
            pix_score: 896,
            max_reachable_level: 7,
            max_reachable_pix_score: 896
        },
        competences: [{
            id: 'racvoGdr7z2z8pXWb',
            title: 'Information et données',
            code: '1',
            color: 'jaffa',
            scorecards: [
                {
                    type: 'scorecards',
                    id: 'userId_racsvLz2W2ShyufE65',
                    attributes: [Object],
                    relationships: [Object]
                },
                //...
            ]},
            //...
        }
    }
    */
})

License

GPLv3

Auteur