forked from ScoDoc/DocScoDoc
API: permission et codes status.
This commit is contained in:
parent
2186f57a14
commit
f8a6c7f864
@ -90,7 +90,7 @@ p = Partition.query.filter_by(id=partition_id).join(FormSemestre).filter_by(dept
|
||||
|
||||
Écriture d'une vue de l'API accessible en mode web et API:
|
||||
```
|
||||
@bp.route("/api_function/<int:arg>")
|
||||
@api_bp.route("/api_function/<int:arg>")
|
||||
@api_web_bp.route("/api_function/<int:arg>")
|
||||
@login_required
|
||||
@scodoc
|
||||
|
@ -40,8 +40,8 @@ su - scodoc
|
||||
|
||||
# Créer un rôle
|
||||
flask create-role LecteurAPI
|
||||
# Lui donner les droits nécessaires: ici APIView
|
||||
flask edit-role LecteurAPI -a APIView
|
||||
# Lui donner les droits nécessaires: ici ScoView
|
||||
flask edit-role LecteurAPI -a ScoView
|
||||
|
||||
# Créer un nouvel utilisateur avec ce rôle:
|
||||
flask user-create lecteur_api LecteurAPI @all
|
||||
@ -116,6 +116,8 @@ parties expérimentales progressivement mises en production à partir de 9.2.12)
|
||||
### Accès à l'API REST
|
||||
|
||||
Elle sera accessible à l'adresse: https://scodoc.monsite.tld/ScoDoc/api/fonction
|
||||
(et aussi https://scodoc.monsite.tld/ScoDoc/api/<dept_acronyme>/fonction pour un
|
||||
accès avec des droits restreints au département).
|
||||
|
||||
#### Authentification
|
||||
|
||||
@ -151,14 +153,13 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ
|
||||
par le serveur ScoDoc.
|
||||
|
||||
* [200](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/200) : OK.
|
||||
* [400](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/401) : Paramètre manquant, ou valeur incorrecte.
|
||||
* [401](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/401) : Authentification nécessaire. (jeton non précisé ou invalide)
|
||||
* [403](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/403) : Action
|
||||
non autorisée pour l'utilisateur associé au jeton
|
||||
* [404](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/404) : Page
|
||||
inaccessible: URL inconnue ou paramètre (id) invalide
|
||||
* [406](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/406) : Le JSON indiqué en données POST n'est pas valide.
|
||||
* [500](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/500) : Erreur inconnue, contactez-nous.
|
||||
non autorisée pour l'utilisateur associé au jeton.
|
||||
* [404](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/401) : Adresse
|
||||
incorrecte, paramètre manquant, ou objet inexistant.
|
||||
* [500](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/500) : Erreur
|
||||
inconnue côté serveur.
|
||||
|
||||
|
||||
## Départements
|
||||
|
Loading…
Reference in New Issue
Block a user