Créer un compte OD
Pour utiliser les fonctionnalités de l'OD il faut posséder un compte utilisateur de celle-ci. Un compte utilisateur OD enregistre les préférences de connexion aux plateformes de dématérialisation, ainsi que d'autres informations personnalisées.
info
Cette API sera probablement étendue dans une prochaine version
Requête
Pour créer un compte utilisateur de l'OD on fait une requête POST sans corps sur le chemin d'accès suivant:
/v1/users
Par exemple:
- cURL
- Typescript
Requête de création d'un utilisateur de l'OD
curl \
-X POST \
http://<host>:<port>/v1/users
Requête de création d'un utilisateur de l'OD
const url = 'http://<host>:<port>/v1/users';
const response: AxiosResponse = await axios.post(url);
...
// récupération de l'URI de la nouvelle ressource
const uri: string = response.headers['location'];
Réponse
Si tout s'est bien passé, la réponse de l'OD est 201 CREATED avec l'en-tête Location contenant l'emplacement de la ressource:
Réponse type de l'OD pour la création d'un compte utilisateur
HTTP/1.1 201 Created
X-Powered-By: Express
X-RateLimit-Limit: 12000
X-RateLimit-Remaining: 11998
X-RateLimit-Reset: 60
Content-Type: application/json; charset=utf-8
Content-Length: 45
ETag: W/"2d-SVoQrUQ9lw1spmQdDLKIlsOgr98"
Date: Thu, 11 Jan 2024 13:45:47 GMT
Connection: keep-alive
Keep-Alive: timeout=5
Location: v1/users/26ad3a21-615e-40ea-a05a-2ac8e8a2f373
Erreurs
Si une erreur s'est produite, les codes et messages suivants peuvent être retournés:
| Code | Message |
|---|---|
| [TODO] | [TODO] |
Impact
- Un compte utilisateur de l'OD a été créé et son identifiant peut maintenant être utilisé avec d'autres APIs