Créer un token d'authentification

POST

/partners/user/auth

curl --request POST \
  --url https://api-demo.apihom.com/partners/user/auth \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "customerId": "client-123", "userId": "user-456", "userName": "Jean Dupont", "customerName": "Agence Immobilière XYZ" }'

• Démo / Test

Crée un token d’authentification pour un utilisateur partenaire et retourne une URL de connexion. L’utilisateur/organisation est créé automatiquement à la première utilisation.

Le token est usage unique — il est supprimé après la première connexion.

Authorizations

• partnerAuth

Request Body ^required

Media type application/json

object

customerId

required

Identifiant client chez le partenaire (ne peut pas contenir ’:’)

string

userId

required

Identifiant utilisateur chez le partenaire (ne peut pas contenir ’:’)

string

userName

required

Nom de l’utilisateur

string

customerName

required

Nom du client/organisation (requis à la première création)

string

dpeId

Numéro DPE ADEME (format : 4 chiffres + E + 7 chiffres + 1 lettre)

string

/^[0-9]{4}E[0-9]{7}[A-Z]$/

showInit

Afficher l’écran d’initialisation au login

boolean

expireInMinutes

Durée de validité du token (en minutes)

integer

default: 10 >= 1

Examples

Authentification simple

{
  "customerId": "client-123",
  "userId": "user-456",
  "userName": "Jean Dupont",
  "customerName": "Agence Immobilière XYZ"
}

Avec DPE ID (accès direct à la pré-analyse)

{
  "customerId": "client-123",
  "userId": "user-456",
  "userName": "Jean Dupont",
  "customerName": "Agence Immobilière XYZ",
  "dpeId": "2575E3361224X",
  "expireInMinutes": 30
}

Responses

201

Token créé avec succès

Media type application/json

object

url

URL de connexion à transmettre à l’utilisateur

string format: uri

Example

{
  "url": "https://app.apihom.com/public/partnerLogin.html?partnerToken=abc123xyz"
}

400

Requête invalide

Media type application/json

object

error

Message d’erreur

string

errorObject

Détails supplémentaires (optionnel)

object

Example

{
  "error": "Demande non valide: dpeId is required"
}

401

Non autorisé — clé partenaire invalide ou manquante

Media type application/json

object

error

Message d’erreur

string

errorObject

Détails supplémentaires (optionnel)

object

Example

{
  "error": "Unauthorized"
}