Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lemaitre4523/pix-api
Un simple module capable d'interagir avec le service français Pix
https://github.com/lemaitre4523/pix-api
javascript pix pix-api wrapper wrapper-api
Last synced: about 1 month ago
JSON representation
Un simple module capable d'interagir avec le service français Pix
- Host: GitHub
- URL: https://github.com/lemaitre4523/pix-api
- Owner: LeMaitre4523
- License: gpl-3.0
- Created: 2024-07-19T21:19:33.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-26T22:35:05.000Z (5 months ago)
- Last Synced: 2024-10-29T01:19:43.947Z (about 2 months ago)
- Topics: javascript, pix, pix-api, wrapper, wrapper-api
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pix API
Un simple module capable d'interagir avec le service français [Pix](https://pix.fr/).
## Features
- Se connecter avec des identifiants/tokens
- Obtenir son profil
- Obtenir ses compétences
- Obtenir ses certifications
- Révoquer les tokens
## Installation
```bash
npm i pix-api-client
```
## Exemples
```javascript
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](https://choosealicense.com/licenses/gpl-3.0/)
## Auteur
- [@LeMaitre4523](https://www.github.com/LeMaitre4523)