Documentation API
Introduction
L'API REST d'HYSUITE permet d'automatiser l'envoi de messages, la lecture de prospects, la gestion des campagnes et l'intégration de webhooks. L'URL de base en production est :
Version publique documentée : v1 (préfixe /api/v1).
Authentification
Modèle type OAuth2 client credentials (applications API enregistrées dans votre espace client) :
Corps JSON : client_id, client_secret. Réponse : access_token (Bearer), durée de vie limitée.
client_secret côté navigateur. Appelez l'API depuis votre backend.
Scopes disponibles (exemples) : messages:send, prospects:read, sessions:read, campaigns:read.
Endpoints principaux
| Méthode | Route | Description |
|---|---|---|
| GET | /v1/health | État du service (public) |
| POST | /v1/auth/token | Obtenir un jeton |
| GET | /v1/sessions | Lister les sessions de messagerie |
| POST | /v1/messages/send | Envoyer un message |
| GET | /v1/prospects | Lister les prospects |
| GET | /v1/prospects/{id} | Détail prospect |
| GET | /v1/campaigns | Campagnes |
En-têtes requis : Authorization: Bearer {token}, Accept: application/json, Content-Type: application/json.
Webhooks
Configurez des webhooks sortants depuis l'interface (événements : messages entrants, statuts, leads). Documentation détaillée : /webhooks (compte requis) ou connexion.
Limites et bonnes pratiques
- Respecter les quotas de votre Plan et le rate limiting serveur ;
- Implémenter retry avec backoff sur les erreurs 429/5xx ;
- Traiter les données personnelles conformément à la loi n° 09-08 et aux exigences de la CNDP ;
- Journaliser les appels côté Client pour audit.
Demande d'accès API
Pour obtenir des identifiants client_id / client_secret, vous devez disposer d'un compte actif. Utilisez le formulaire ci-dessous ou créez une application depuis Paramètres → Applications API une fois connecté.