jmplace/DocScoDoc
1
0
Fork 0
forked from ScoDoc/DocScoDoc
Code Issues Pull Requests Projects Releases Wiki Activity

détails sur API avec CAS et routes départementales

Browse Source
This commit is contained in:
Emmanuel Viennet 2023-03-30 11:46:02 +02:00
parent c78fcad6e7
commit 74fbd3f3f4
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/ScoDoc9API.md
View File

@ -63,18 +63,29 @@ flask user-password lecteur_api
... ...
``` ```
Si vous êtes intéressé par le développement, voir Si vous êtes intéressé par le développement, voir
* [la section sur les tests unitaires de l'API](TestsScoDoc.md#tests-de-lapi-scodoc9); * [la section sur les tests unitaires de l'API](TestsScoDoc.md#tests-de-lapi-scodoc9);
* [la documentation interne](Internals.md#vues-de-lapi-et-permissions). * [la documentation interne](Internals.md#vues-de-lapi-et-permissions).
!!! note "Voir aussi"
- Si vous utilisez le CAS, pensez à laisser les comptes utilisateurs API se
connecter via ScoDoc sans CAS. Pour cela, cocher l'option
*Autorise connexion via CAS si CAS est activé*
dans leur formulaire de configuration.
- Si l'utilisateur est associé à un département (cas des comptes créés via l'interface Web),
il ne pourra accéder à l'API que via une *route départementale*, c'est à dire une route comprenant
l'acronyme de son département, de la forme `https://...//ScoDoc/DEPARTEMENT/api/...`.
## Essais avec HTTPie ## Essais avec HTTPie
[HTTPie](https://httpie.io/) est un client universel livre et gratuit très commode, disponible [HTTPie](https://httpie.io/) est un client universel livre et gratuit très commode, disponible
pour Windows, Linux, en ligne de commande ou interface graphique. pour Windows, Linux, en ligne de commande ou interface graphique.
Exemple d'utilisation en ligne de commande et interroger votre ScoDoc pour obtenir la Exemple d'utilisation en ligne de commande et interroger votre ScoDoc pour
liste des départements: obtenir la liste des départements:
```bash ```bash
http -a USER:PASSWORD POST 'http://localhost:5000/ScoDoc/api/tokens' http -a USER:PASSWORD POST 'http://localhost:5000/ScoDoc/api/tokens'
@ -128,10 +139,12 @@ version de ScoDoc 9.3.25.
### Accès à l'API REST ### Accès à l'API REST
L'API est accessible à l'adresse: `https://scodoc.monsite.tld/ScoDoc/api/<fonction>`, L'API est accessible à l'adresse:
et aussi `https://scodoc.monsite.tld/ScoDoc/<dept_acronyme>/api/<fonction>` pour un `https://scodoc.monsite.tld/ScoDoc/api/<fonction>`, et aussi via les *routes
accès avec des droits restreints au département indiqué. départementales* de la forme
(<fonction> à choisir dans [Référence](#reference).) `https://scodoc.monsite.tld/ScoDoc/<dept_acronyme>/api/<fonction>` pour un accès
avec des droits restreints au département indiqué. La liste des `<fonction>` est
donnée dans [Référence](#reference).
#### Authentification #### Authentification