Authentification
Le widget utilise un identifiant de site public. L’API REST utilise des clés secrètes envoyées sous forme de jeton Bearer.
Clés
| Clé | Exemple | Où l’utiliser |
|---|---|---|
| Identifiant de site | site_8Kq2mXvR | Dans votre HTML. Public, il identifie uniquement le site auquel appartient le widget. |
| Clé secrète | yk_live_… | Sur votre serveur. Donne un accès complet aux données de votre espace de travail. |
| Clé secrète de test | yk_test_… | Sur votre serveur, pendant le développement. Accède uniquement aux données du mode test. |
| Secret de vérification d’identité | idv_… | Vérification d’identité |
| Secret webhook | whsec_… | Vérification des webhooks |
Créez et révoquez vos clés dans le tableau de bord, sous Paramètres → Développeurs. Vous pouvez utiliser plusieurs clés secrètes à la fois pour faciliter leur renouvellement : créez une nouvelle clé, déployez-la, puis révoquez l’ancienne.
Envoyer votre clé
Transmettez la clé secrète dans l’en-tête Authorization à chaque requête :
curl https://api.yuno.chat/v1/contacts \
-H "Authorization: Bearer yk_test_51Hq8…"Une clé absente ou invalide renvoie 401. Une clé existante sans les droits nécessaires, par exemple une clé restreinte utilisée pour une opération d’écriture, renvoie 403.
Clés restreintes
Lors de la création d’une clé, vous pouvez limiter son accès à la lecture seule ou à certaines ressources. Une clé destinée à un tableau de bord de suivi n’a par exemple besoin que d’un accès en lecture aux conversations et aux tickets.
Mode test
Chaque espace de travail dispose d’un mode test avec ses propres données. Les requêtes utilisant une clé yk_test_ accèdent uniquement aux conversations, tickets et contacts de test. En mode test :
- aucun e-mail n’est envoyé aux contacts ; les messages apparaissent dans la boîte de réception de test du tableau de bord ;
- les webhooks sont envoyés uniquement aux points de terminaison créés en mode test ;
- le widget fonctionne en mode test lorsque vous ajoutez
data-mode="test"à la balise script.