Skip to main content

API Crédits

Cette API vous permet de récupérer le nombre total de crédits disponibles sur votre compte, incluant les crédits liés à votre abonnement et les crédits supplémentaires.

Authentification (obligatoire)

Depuis la migration vers l’App Router, l’authentification est obligatoire pour cet endpoint :
  • Header x-api-key : Votre clé API (générée dans l’Espace Développeur)
  • Corps de requête user_id : L’identifiant utilisateur associé à cette clé API
La clé API doit correspondre à l’utilisateur dans votre abonnement Home Staging. En cas d’absence ou d’invalidité de la clé, une erreur 401 Unauthorized sera retournée.

Récupérer ses crédits

Ce endpoint vous permet d’obtenir les informations détaillées sur vos crédits disponibles.

Paramètres de la requête

string
requis
L’identifiant unique de l’utilisateur (UUID) que vous pouvez récupérer dans votre Espace Développeur

Réponse

number
Le nombre total de crédits disponibles sur votre compte
number
Le nombre de crédits issus de votre abonnement
number
Le nombre de crédits supplémentaires achetés séparément

Exemple de requête

Exemple de réponse

Codes d’erreur