Aller au contenu

Authentification

Toutes les routes de l’API REST server-to-server s’authentifient avec une clé API via le header X-API-Key.

X-API-Key: sk_live_agent_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
CléUsageExposable ?
sk_live_agent_…API REST serveur (cette doc)Non — backend uniquement
pk_live_…Widget navigateur (embed client)Oui — frontend

La clé publique (pk_live_) est refusée sur les routes de l’API REST server-to-server. Vous obtiendriez une réponse 403 AUTH_API_KEY_FORBIDDEN.

Les clés API se créent depuis Paramètres → Clés API dans le dashboard admin. Vous pouvez en créer plusieurs (une par environnement, par intégration, etc.) et les révoquer individuellement.

La clé complète est affichée une seule fois à la création — copiez-la immédiatement.

Un appel read-only, sans effet de bord, qui renvoie l’app associée à votre clé :

curl
curl https://supportdesk.innovartx.com/api/v1/auth/whoami \
-H "X-API-Key: $SUPPORTDESK_API_KEY"

Si tout est OK, vous recevez un 200 OK avec :

{
"success": true,
"data": {
"appId": "cl…",
"slug": "votre-app",
"name": "Votre App",
"keyType": "agent"
}
}
Code HTTPCode métierCause
401AUTH_API_KEY_MISSINGLe header X-API-Key est absent
401AUTH_API_KEY_INVALIDLa clé est mal formatée ou introuvable
401AUTH_API_KEY_EXPIREDLa clé a dépassé sa date d’expiration
403AUTH_API_KEY_FORBIDDENVous avez utilisé une pk_live_ au lieu d’une sk_live_agent_

Voir Erreurs pour le format complet des réponses d’erreur.