entrouvert/wcs
entrouvert
/
wcs
14
1
Fork 0
Code Issues Pull Requests 31 Releases Activity

doc: remove infos about /api/user/ & /api/users/ (#57304) 

(authentic APIs should be used)
This commit is contained in:
Frédéric Péters 2021-09-27 15:25:35 +02:00
parent c25e7e6074
commit 0f9ef593e4
1 changed files with 6 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
help/fr/api-user.page
View File

@ -8,56 +8,22 @@
<name>Frédéric Péters</name>
<email>fpeters@entrouvert.com</email>
</credit>
<desc>Profil utilisateur, formulaires associés, etc.</desc>
<desc>Demandes et brouillons d’un usager</desc>
</info>
<title>Récupération des données d’un utilisateur</title>
<title>Récupération des données d’un usager</title>
<p>
Il s’agit ici d’API permettant à un logiciel tiers de récupérer les données
associées aux utilisateurs enregistrés.
associées aux usagers enregistrés.
</p>
<section>
<title>Profil</title>
<p>
Ces accès doivent se faire en passant les informations d’identification
appropriées dans la <em>query string</em>.
</p>
<p>
Les informations associées à un utilisateur sont accessibles à l’URL
<code>/api/user/</code>, elles reprennent son nom (<code>user_display_name</code>),
son adresse électronique (<code>user_email</code>) ainsi que ses éventuelles
autorisations d’accès au backoffice (<code>user_backoffice_access</code>) ou
à l’interface d’administration (<code>user_admin_access</code>).
</p>
<screen>
<output style="prompt">$ </output><input>curl https://www.example.net/api/user/<var>?signature…</var></input>
<output>{
"user_display_name": "Fred Cuadrado",
"user_email": "fred@example.net",
"user_backoffice_access": true,
"user_admin_access": false
}
</output></screen>
<note>
<p>Note de compatibilité : cette information est également disponible à
l’adresse <code>/user</code>.
</p>
</note>
</section>
<section id="forms">
<title>Formulaires</title>
<title>Demandes</title>
<p>
La liste des formulaires transmis par un utilisateur est accessible à l’URL
La liste des demandes transmis par un usager est accessible à l’URL
<code>/api/user/forms</code>, elle reprend un ensemble minimal
d’informations concernant chacun de ceux-ci.
</p>
@ -140,7 +106,7 @@ brouillons, un paramètre <code>include-drafts=true</code> peut être passé.
<title>Brouillons</title>
<p>
La liste des brouillons de l’utilisateur est accessible à l’adresse
La liste des brouillons de l’usager est accessible à l’adresse
<code>/api/user/drafts</code>.
</p>
@ -158,43 +124,6 @@ brouillons, un paramètre <code>include-drafts=true</code> peut être passé.
]
}</output></screen>
<note>
<p>Note de compatibilité : cette information est également disponible à
l’adresse <code>/myspace/drafts</code>.
</p>
</note>
</section>
<section>
<title>Liste des utilisateurs</title>
<p>
La liste des utilisateurs est disponible à l’URL <code>/api/users/</code>,
il est possible de la filtrer, sur le nom ou l’adresse électronique, en
spécifiant un paramètre <code>q</code> et de limiter le nombre de
résultats obtenus avec le paramètre <code>limit</code>.
</p>
<screen>
<output style="prompt">$ </output><input>curl -H "Accept: application/json" \
https://www.example.net/api/users/?q=fred<var>&amp;signature…</var></input>
<output>
{
"err": 0,
"data": [
{
"user_display_name": "Fred",
"user_email": "fred@example.net",
"user_backoffice_access": true,
"user_admin_access": false
}
}
}
</output>
</screen>
</section>
</page>