@metarisc/metarisc-js v0.0.1-alpha.58
Metarisc JS
La librairie Metarisc JS offre un accès simple et pratique à l'API Metarisc à partir d'applications écrites en langage JS. Elle comprend un ensemble de classes et de fonctions pour l'ensemble des ressources de l'API.
NPM
Vous pouvez installer la librairie en utilisant NPM. Exécutez la commande suivante dans votre projet :
npm i @metarisc/metarisc-js
Pour utiliser la librairie, il suffit de l'importer comme ceci :
import { Metarisc } from '@metarisc/metarisc-js';
Utilisation
Requêtes
Pour effectuer une requête sur Metarisc, il faut tout d'adord initialisé le client metarisc de cette manière :
const m = new Metarisc({
metarisc_url: "https://api.metarisc.fr",
client_id: "CLIENT_ID",
client_secret: "CLIENT_SECRET"
});
m.dossiers.getDossier("123456");
Ensuite vous pouvez faire vos requêtes.
Requêtes simple
Pour faire un appel API après initialisation du client, vous pouvez utiliser l'accès rapide à l'API souhaitée.
Exemple :
m.dossiers.getDossier("123456");
Le type de retour d'une requête simple est :
Promise<AxiosResponse<T>>;
(voir les documentations suivantes Promise et AxiosResponse)
Requêtes paginées
Pour récupérer des résultats paginés Metarisc (voir la documentation), il suffit de faire appel à l'api souhaitée de la même manière que pour une requête simple.
Exemple :
const m = new Metarisc(config);
m.NotificationsAPI.paginateNotifications();
Le type de retour d'une requête paginée est :
AsyncGenerator<T>;
(voir la documentation suivante AsyncGenerator)
17 days ago
18 days ago
18 days ago
18 days ago
18 days ago
22 days ago
22 days ago
23 days ago
24 days ago
24 days ago
25 days ago
25 days ago
25 days ago
25 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
3 months ago
5 months ago
8 months ago
8 months ago
8 months ago
8 months ago
6 months ago
8 months ago
6 months ago
6 months ago
8 months ago
8 months ago
8 months ago
8 months ago
8 months ago
9 months ago
6 months ago
12 months ago
12 months ago
12 months ago
12 months ago