Aperçu de l'API Zendesk Sunshine Conversations : Un guide du développeur pour 2026

Si vous développez une solution de messagerie client, vous avez probablement été confronté au cauchemar de la gestion d'intégrations distinctes pour WhatsApp, Facebook Messenger, SMS et le chat intégré à l'application. Chaque canal a sa propre API, sa documentation et ses particularités. La charge de maintenance se multiplie avec chaque canal que vous ajoutez.

Zendesk Sunshine Conversations résout ce problème en fournissant une seule API REST qui unifie plus de 14 canaux de messagerie. Initialement développé sous le nom de Smooch.io avant son acquisition par Zendesk, Sunshine Conversations permet aux développeurs de construire une seule fois et de déployer sur toutes les principales plateformes de messagerie.

Dans ce guide, je vais détailler exactement ce que l'API Sunshine Conversations offre, comment elle fonctionne et ce que vous devez savoir pour commencer. Je vais également montrer comment eesel AI offre une alternative pour les équipes qui souhaitent une messagerie basée sur l'IA sans créer d'intégrations personnalisées.

Qu'est-ce que Zendesk Sunshine Conversations ?

Sunshine Conversations est une plateforme de messagerie multicanal qui se trouve au cœur de l'écosystème d'expérience client de Zendesk. Elle agit comme une couche de traduction entre votre application et des dizaines de canaux de messagerie, normalisant les particularités de chaque plateforme en une API cohérente.

La plateforme s'adresse à deux principaux publics :

Pour les développeurs, elle élimine le besoin de créer des intégrations distinctes pour chaque canal de messagerie. Au lieu d'apprendre les particularités de l'API WhatsApp Business, les formats de webhook de Facebook Messenger et les bizarreries des fournisseurs de SMS, vous intégrez une seule fois avec Sunshine Conversations et la plateforme s'occupe du reste.

Pour les entreprises, elle permet de connecter des outils existants tels que les services d'assistance, les CRM et les plateformes de bots aux clients via leurs canaux de messagerie préférés, souvent sans écrire de code.

L'héritage de Smooch.io

Sunshine Conversations a commencé sa vie sous le nom de Smooch.io, une plateforme de messagerie autonome que Zendesk a acquise. Vous rencontrerez encore des références à Smooch dans la documentation héritée et certains référentiels de SDK. La plateforme principale a été entièrement intégrée à la Suite de Zendesk, mais l'architecture de l'API et de nombreux points de terminaison conservent l'ADN de Smooch.

Pour les clients Zendesk sous licence, l'URL de base est https://{subdomain}.zendesk.com/sc. Les anciens comptes Sunshine Conversations utilisent toujours https://api.smooch.io.

Capacités et architecture de l'API principale

L'API Sunshine Conversations suit les principes REST avec des corps de requête et de réponse JSON. La version actuelle est la v2, bien que la v1.1 reste prise en charge pour les intégrations existantes.

Points de terminaison et ressources clés

L'API est centrée sur plusieurs ressources principales :

Tous les points de terminaison utilisent les méthodes HTTP standard : GET pour la récupération, POST pour la création, PATCH pour les mises à jour et DELETE pour la suppression. L'API renvoie des formats d'erreur cohérents avec des codes d'état HTTP et des objets d'erreur descriptifs.

Pagination et limites

Sunshine Conversations utilise la pagination basée sur un curseur plutôt que la pagination par décalage. Cette approche évite les problèmes de performance avec les grands ensembles de données en renvoyant un pointeur vers un élément spécifique plutôt que des numéros de page.

Vous pouvez utiliser les paramètres de requête page[after] ou page[before] pour naviguer vers l'avant ou vers l'arrière dans les résultats. Un paramètre facultatif page[size] contrôle le nombre d'enregistrements renvoyés par requête.

Soyez conscient de ces limites strictes :

Lorsque vous atteignez les limites de débit, l'API renvoie un état 429 Too Many Requests. Mettez en œuvre un repli exponentiel avec gigue plutôt que des intervalles de nouvelle tentative fixes. Les pics d'utilisation sont attendus et les limites sont conçues pour être généreuses pour les opérations normales.

Authentification et sécurité

Sunshine Conversations prend en charge deux méthodes d'authentification, chacune adaptée à différents cas d'utilisation.

Authentification de base

Pour les appels d'API de serveur à serveur, l'authentification de base est l'approche la plus simple. Vous utilisez votre ID de clé API comme nom d'utilisateur et le secret comme mot de passe au format d'authentification de base HTTP standard.

Cette méthode fonctionne bien pour les intégrations backend où vous effectuez des appels de votre serveur à l'API Sunshine Conversations. Elle est simple à mettre en œuvre et à déboguer.

Authentification JWT

Les jetons Web JSON (JWT, JSON Web Tokens) offrent une option d'authentification plus flexible, particulièrement utile lorsque vous devez limiter étroitement l'accès ou lorsque vous transmettez des informations d'identification via des canaux moins sécurisés.

Pour générer un JWT, vous avez besoin de :

• En-tête avec algorithme (HS256) et ID de clé
• Charge utile avec revendication de portée (compte, application ou intégration)
• Signature utilisant votre secret d'API

Les JWT sont transmis dans l'en-tête Authorization avec le préfixe Bearer : Authorization: Bearer your-jwt-token.

Portées d'autorisation

L'API utilise trois principales portées d'autorisation qui déterminent les opérations autorisées :

Les clés API suivent une convention de nommage qui indique leur portée : les clés de compte commencent par act_, les clés de compte de service par svc_ et les clés d'application par app_.

Canaux de messagerie pris en charge

Sunshine Conversations prend en charge la gamme la plus complète de canaux de messagerie du secteur. Tous les canaux sont accessibles via la même API, la plateforme gérant la traduction entre les formats spécifiques aux canaux et l'API unifiée.

Applications de messagerie tierces

• API WhatsApp Business - Prise en charge complète de la messagerie professionnelle, des modèles et des médias riches
• Facebook Messenger - Intégration complète avec les boutons, les réponses rapides et les vues Web
• Instagram Direct - Messagerie via les comptes professionnels Instagram
• Apple Messages for Business - Intégration avec la plateforme de messagerie professionnelle d'Apple
• LINE, Telegram, Viber - Prise en charge complète des principales plateformes de messagerie asiatiques et européennes
• Twitter DM - Messagerie directe via Twitter
• WeChat - Prise en charge de la plateforme de messagerie dominante en Chine

Fournisseurs de SMS et de voix

• Twilio - Intégration SMS via l'infrastructure de Twilio
• MessageBird - Intégration alternative du fournisseur SMS

SDK créés par Zendesk

• Web Messenger - Widget de chat intégrable pour les sites Web
• SDK Android - Messagerie intégrée à l'application Android native
• SDK iOS - Messagerie intégrée à l'application iOS native
• SDK Unity - Intégration d'applications de jeux et 3D

La plateforme prend en charge les fonctionnalités de messagerie enrichie sur les canaux où elles sont disponibles, y compris les messages structurés, les réponses rapides, les carrousels et le partage de fichiers. Lorsque les canaux ajoutent de nouvelles fonctionnalités, Sunshine Conversations se met généralement à jour pour les prendre en charge avec un minimum de modifications de code requises de votre côté.

Outils de développement et SDK

Bien que vous puissiez interagir directement avec l'API Sunshine Conversations via HTTP, Zendesk fournit des SDK officiels qui encapsulent l'API et gèrent l'authentification, la gestion des erreurs et le formatage des requêtes.

SDK officiels

Le SDK Java reçoit la maintenance la plus active de Zendesk. Les SDK Ruby et Python sont générés automatiquement à partir de la spécification OpenAPI, ce qui garantit qu'ils restent à jour avec les modifications de l'API, mais qu'ils manquent potentiellement d'ergonomie artisanale.

Outils de développement

Pour les tests et l'exploration, Zendesk fournit une collection Postman qui inclut tous les points de terminaison avec des exemples de requêtes. La spécification OpenAPI est disponible publiquement pour générer des clients ou une documentation personnalisés.

Intégration de webhook

La gestion des événements en temps réel se fait via des webhooks. Votre serveur expose un point de terminaison qui reçoit des requêtes POST lorsque des événements se produisent, tels que des messages entrants, des confirmations de livraison ou des changements d'état de conversation.

Les déclencheurs de webhook courants incluent :

Vous devrez vérifier les signatures de webhook à l'aide du secret partagé fourni lorsque vous créez l'intégration de webhook pour vous assurer que les événements proviennent réellement de Sunshine Conversations.

Intégration avec l'écosystème Zendesk

Sunshine Conversations n'existe pas de manière isolée. Il est profondément intégré à la plateforme Zendesk plus large, ce qui peut accélérer le développement ou fournir des approches alternatives en fonction de votre cas d'utilisation.

Web Widget

Le Web Widget fournit une interface de chat client qui s'intègre à votre site Web ou à votre centre d'aide. Il utilise Sunshine Conversations en coulisses, de sorte que les conversations démarrées via le widget transitent par la même API que celle que vous utilisez pour les autres canaux.

Espace de travail de l'agent

Lorsque les conversations nécessitent une intervention humaine, elles apparaissent dans l'espace de travail de l'agent de Zendesk sous forme de tickets. Les agents peuvent répondre directement, et leurs messages sont renvoyés via Sunshine Conversations au client sur son canal d'origine. Cela vous donne une interface d'agent unifiée, même lorsque les clients sont répartis sur une douzaine de plateformes de messagerie.

Tableau de répartition

Le tableau de répartition contrôle le routage des conversations entre les bots, les systèmes d'IA et les agents humains. Vous pouvez transmettre par programme le contrôle entre les systèmes tout en conservant le contexte de la conversation. Cela permet des flux de travail sophistiqués comme le triage bot-first avec une escalade transparente vers les humains.

Chez eesel AI, nous tirons parti de ces points d'intégration pour fournir un service client basé sur l'IA qui fonctionne nativement dans Zendesk. Nos agents d'IA peuvent gérer les conversations via Sunshine Conversations, escalader vers des agents humains si nécessaire et maintenir un contexte complet tout au long de l'interaction.

Tarification et accès à Zendesk Suite

L'accès à l'API Sunshine Conversations nécessite des plans Zendesk Suite spécifiques. Tous les niveaux n'incluent pas toutes les fonctionnalités de la plateforme.

Distinction clé : Suite Team et Growth incluent la messagerie via le Web Widget, mais ne fournissent pas un accès complet à l'API pour les intégrations personnalisées. Pour créer vos propres intégrations avec l'API Sunshine Conversations, vous avez besoin de Suite Professional ou Enterprise.

Les utilisateurs actifs mensuels (MAU, Monthly Active Users) représentent les utilisateurs uniques qui envoient ou reçoivent des messages sur une période de 30 jours. Si vous dépassez vos MAU inclus, des packs supplémentaires sont disponibles à environ 50 $ par 2 500 MAU.

Source : Tarification de Zendesk

Démarrage avec le développement de Sunshine Conversations

Si vous êtes prêt à développer avec Sunshine Conversations, voici ce dont vous avez besoin pour commencer.

Prérequis

1. Zendesk Suite Professional ou Enterprise - Requis pour un accès complet à l'API
2. Accès au Centre d'administration - Pour générer des clés API et configurer des canaux
3. Environnement de développement - Un serveur ou une fonction cloud pour recevoir des webhooks
4. Compréhension de base des API REST - Pour effectuer des appels d'API et gérer les réponses

Étapes de démarrage rapide

1. Générer des clés API - Dans le Centre d'administration, accédez à Applications et intégrations > API > API Conversations. Créez une nouvelle clé et stockez en toute sécurité l'ID d'application, l'ID de clé et le secret.

2. Configurer un point de terminaison de webhook - Créez un point de terminaison HTTPS accessible au public qui peut recevoir des requêtes POST. Pour le développement local, des outils comme ngrok peuvent créer des tunnels vers votre machine.

3. Configurer votre premier canal - Dans le Centre d'administration, activez un canal de messagerie (le Web Widget est le plus facile pour commencer) et connectez-le à votre application Sunshine Conversations.

4. Tester l'intégration - Envoyez un message via le canal choisi et vérifiez qu'il atteint votre point de terminaison de webhook. Essayez ensuite d'envoyer une réponse via l'API.

Pour une présentation plus détaillée, consultez notre guide de démarrage complet.

eesel AI : Messagerie basée sur l'IA sans développement personnalisé

La création d'intégrations personnalisées avec Sunshine Conversations nécessite des ressources de développement importantes. Si votre objectif est un service client basé sur l'IA plutôt que la création d'une plateforme de messagerie personnalisée, demandez-vous si vous devez construire quoi que ce soit.

Chez eesel AI, nous fournissons des agents d'IA qui s'intègrent directement à Zendesk, gérant la complexité de Sunshine Conversations, l'orchestration du tableau de répartition et la messagerie multicanal sans nécessiter de développement personnalisé. Vous obtenez un service client basé sur l'IA qui fonctionne sur tous les canaux de messagerie, avec une escalade humaine et une intégration Zendesk complète, sans écrire de code.

Pour les équipes qui cherchent à ajouter des fonctionnalités de chat IA à leur service d'assistance existant, notre chatbot IA fonctionne sur les canaux de messagerie avec la même approche unifiée que Sunshine Conversations, mais sans les frais généraux de développement. Si vous avez besoin d'aide pour gérer le volume de tickets, AI Triage achemine, étiquette et hiérarchise automatiquement les tickets avant qu'ils n'atteignent vos agents.