Obtenir l’accès
Pour accéder à l’API WelcomeHome, vous devez disposer d’un API Token.
- Si vous êtes administrateur dans WelcomeHome, vous pouvez gérer et générer des API Tokens dans la section de configuration des API Tokens.
- Si vous êtes un partenaire tiers intégrant WelcomeHome, notre équipe Support peut vous fournir un accès à un compte de test.
Veuillez contacter : emily@welcomehomesoftware.com
Pour un accès en production, votre client devra vous fournir un API Token spécifique à son compte WelcomeHome.
Autorisation
Lors de vos requêtes API, vous devez inclure votre API Token dans l’en-tête Authorization comme suit :
Authorization: Token token={your_token_here}
Vous pouvez tester votre API Token en utilisant le endpoint :
/api/ping
Exemple avec curl :
curl https://crm.welcomehomesoftware.com/api/ping \
-H "Authorization: Token token={token_here}"
Réponses possibles
✅ Autorisation réussie
- Code de réponse : 200
- Corps JSON contenant les informations du compte auquel le token donne accès
Exemple :
{"account_id":2}
❌ Autorisation échouée
- Code de réponse : 401
- Message :
{"error":"Bad credentials"}
Documentation des endpoints API
Une fois que vous disposez d’un API Token valide et que le test /api/ping fonctionne correctement, vous pouvez consulter la documentation complète des endpoints disponibles via ce lien :