forked from ScoDoc/DocScoDoc
détails sur API avec CAS et routes départementales
This commit is contained in:
parent
c78fcad6e7
commit
74fbd3f3f4
@ -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 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
|
||||
|
||||
[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.
|
||||
|
||||
Exemple d'utilisation en ligne de commande et interroger votre ScoDoc pour obtenir la
|
||||
liste des départements:
|
||||
Exemple d'utilisation en ligne de commande et interroger votre ScoDoc pour
|
||||
obtenir la liste des départements:
|
||||
|
||||
```bash
|
||||
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
|
||||
|
||||
L'API est accessible à l'adresse: `https://scodoc.monsite.tld/ScoDoc/api/<fonction>`,
|
||||
et aussi `https://scodoc.monsite.tld/ScoDoc/<dept_acronyme>/api/<fonction>` pour un
|
||||
accès avec des droits restreints au département indiqué.
|
||||
(<fonction> à choisir dans [Référence](#reference).)
|
||||
L'API est accessible à l'adresse:
|
||||
`https://scodoc.monsite.tld/ScoDoc/api/<fonction>`, et aussi via les *routes
|
||||
départementales* de la forme
|
||||
`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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user