Créer une connexion

L'API création de connexion permet aux utilisateurs de l'OD de créer des connexions à une PDP ou au PPF

info

S'il s'agit d'une connexion PDP API First, elle devra être finalisée en suivant le parcours de création utilisateur de la PDP avant de pouvoir être utilisée

Pré-requis

• Posséder un compte OD

Requête

Pour créer une connexion PDP ou PPF on fait une requête POST sur le chemin d'accès suivant:

v1/connexions

On doit passer:

• L'identifiant utilisateur de l'OD dans l'en-tête X-OD-User-ID
• Les paramètres de connexion au format JSON dans le corps de la requête

Par exemple:

cURL

Requête de création de connexion PDP API First

curl \
-X POST \
-H 'X-OD-User-ID: ${userId}' \
-H 'Content-Type: application/json; charset=utf-8' \
-d @connexion.json \
http://<host>:<port>/v1/connexions

Typescript

Requête de création de connexion PDP API First

const url = 'http://<host>:<port>/v1/connexions'
const data: string = fs.readFileSync('connexion.json');
const response: AxiosResponse = await axios.post(url, data, {
    headers: {
        'X-OD-User-ID': userId,
        'Content-Type': 'application/json; charset=utf-8',
    }
});
...
// récupération de l'URI de la nouvelle ressource
const uri: string = response.headers['location'];

Fichier connexion.json

{
    "connectionType": "PDP",
    "firstName": "Patrick",
    "lastName": "Maurice",
    "email": "email@gmail.com",
    "siren": "810319517",
    "companyName": "Dougs",
    "regimeFiscal": "NORMAL_MENSUEL"
}

Propriété	Valeur	Utilisation	Requis
connectionType	PDP | PPF	Type de connexion souhaitée	Oui
firstName	Prénom de l'utilisateur	Pré-remplissage des informations du compte	Non
lastName	Nom de l'utilisateur	Pré-remplissage des informations du compte	Non
email	Adresse email de l'utilisateur	Pré-remplissage des informations du compte	Non
siren	N° SIREN de l'entreprise	Pré-remplissage des informations du compte	Non
companyName	Nom de l'entreprise	Pré-remplissage des informations du compte	Non
regimeFiscal	Régime fiscal de l'entreprise	Pré-remplissage des informations du compte	Non

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 une création de connexion

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/connexions/26ad3a21-615e-40ea-a05a-2ac8e8a2f373

Erreurs

Si une erreur s'est produite, les codes et messages suivants peuvent être retournés:

Code	Message
400 Bad Request	Requête invalide - Voir messages d'erreur
401 Unauthorized	Informations d'authentification invalides
409 Conflict	Une connexion de ce type existe déjà pour cet utilisateur

Impact

Une connexion PDP ou PPF associée à l'utilsateur de l'OD est maintenant créée avec le statut PENDING

La connexion devra être finalisée selon les modalités propres à chaque PDP ou au PPF

A tout moment la connexion peut être consultée via l'API de consulter une connexion