Aller au contenu

Authentification

L'API du Portail Funéraire utilise le protocole OAuth2 avec le flux Resource Owner Password Credentials (grant_type=password).

Principe

  1. Le client s'authentifie avec le header Authorization: Basic contenant l'encodage Base64 de {clientId}:{clientSecret}.
  2. Le client envoie ses identifiants utilisateur (username et password) dans le body.
  3. Le serveur retourne un access_token.
  4. Le client utilise ce jeton pour appeler les endpoints de l'API.

Environnements

Environnement URL de base
PREPROD https://bo-pprod.logiciels-carbone14.fr/pcborec
PROD https://bo-prod.logiciels-carbone14.fr/pcborec

Récupération du token

Requête

  • URL : {url_base}/oauth/token
  • Méthode : POST
  • Content-Type : application/x-www-form-urlencoded
  • Authorization : Basic (encodage Base64 de {clientId}:{clientSecret})

Paramètres du body

Paramètre Description
username Nom d'utilisateur
password Mot de passe
grant_type Valeur : password

Exemple curl

curl -X POST "{url_base}/oauth/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -u "{clientId}:{clientSecret}" \
  -d "username={username}" \
  -d "password={password}" \
  -d "grant_type=password"

Réponse

{
    "access_token": "e944bf88-dadf-483f-acc8-44860ead638a",
    "token_type": "bearer",
    "expires_in": 9559,
    "scope": "read write trust C14-ADMIN"
}

Scope et droits d'accès

Le champ scope contient la liste des BU (Business Units) auxquelles le client a accès en lecture.

Chaque scope correspond à une BU sur laquelle l'utilisateur est autorisé à consulter les données.

Utilisation du token

Toutes les requêtes doivent contenir le header suivant :

Authorization: Bearer {access_token}

Exemple :

curl -X GET "{url_base}/api/endpoint" \
  -H "Authorization: Bearer {access_token}"

Expiration du token

Le token a une durée de validité limitée (expires_in, en secondes).

Lorsque le token expire, vous devez en demander un nouveau en répétant la requête d'authentification.