Vidéo explicative sur l'intégration de l'API
Une vidéo explicative sur l'intégration d'API montre comment une action dans un système entraîne un traitement, un échange de données et un résultat dans un autre système. Ceci est particulièrement utile pour les solutions SaaS, l'informatique et d'autres processus complexes où la valeur ajoutée de la connexion n'est pas évidente à partir d'un simple enregistrement d'écran. Une animation dédiée à l'informatique et aux solutions SaaS permet de visualiser ce contexte.
Dans quelles situations ce type de vidéo est-il le plus adapté ?
Ce format est optimal lorsqu'une API fait partie d'un flux de travail au sein d'un site web, d'un portail ou d'une application. Une animation de tutoriel logiciel montre les clics, mais pas ce qui se passe ensuite entre les systèmes ni pourquoi l'étape suivante est automatiquement disponible.
Avec plusieurs outils, des approbations ou des volumes importants, une simple explication de fonctionnalité est souvent insuffisante. Dans ce cas, il est essentiel de montrer comment les tâches manuelles sont automatisées, comment les processus sont simplifiés et comment le parcours utilisateur est plus clair. C'est pourquoi une vidéo explicative sur l'intégration d'une API est idéale pour présenter une solution SaaS, accompagner l'intégration des nouveaux utilisateurs, expliquer une nouvelle version ou décrire d'autres processus complexes.
Quelles informations sont indispensables à l'intrigue ?
- Le point de départ : quelle action, requête ou événement déclenche l’intégration, et quels systèmes sont impliqués ?.
- L’échange : quelles données ou quels signaux sont échangés, et quel en est le résultat visible pour l’utilisateur, l’équipe ou le client ?.
- L’évolution du parcours utilisateur : quelles étapes disparaissent, où les erreurs diminuent et où l’expérience semble plus intégrée ?.
- N’incluez que les technologies pertinentes : l’authentification, la gestion des erreurs, les approbations ou les webhooks ne doivent être intégrés que s’ils sont nécessaires à la compréhension de la logique du processus.
API, application ou intégration standard : que faut-il expliquer et quand ?
| Forme d'intégration | Considération la plus importante | Ce que la vidéo doit expliquer | Une approche vidéo qui s'adapte souvent |
|---|---|---|---|
| Connexion API directe | Beaucoup de flexibilité et de personnalisation, mais généralement aussi une coordination technique plus poussée, des dépendances et une logique de processus en coulisses. | Décrivez l'intégralité du processus : déclencheur, systèmes impliqués, échange de données, statuts, exceptions et résultat métier. Le contexte est ici plus important que de simplement indiquer où l'utilisateur clique. | Une vidéo explicative de processus ou une vidéo technique est souvent appropriée. Privilégiez cette option si la valeur ajoutée réside principalement dans le déroulement général et non dans une fonctionnalité isolée. |
| Application ou application web | L'utilisateur travaille principalement au sein de sa propre interface ; l'API prend en charge les fonctions en arrière-plan. L'adoption, la compréhension et l'exécution des tâches sont essentielles. | Montrez les actions de l'utilisateur, les changements visibles et la provenance et la destination des données. Incluez uniquement les détails techniques nécessaires à la compréhension de l'expérience utilisateur. | Une présentation des fonctionnalités ou une vidéo d'intégration est souvent efficace. Cela convient particulièrement lorsque l'activation et l'utilisation quotidienne priment sur l'architecture technique. |
| Intégration ou extension standard | Plus rapide et plus facile à mettre en œuvre, souvent avec moins de personnalisation et un effort informatique limité, mais aussi avec des limites fonctionnelles plus claires. | Mettez l'accent sur la manière dont la connexion est activée, sur les fonctionnalités standard disponibles, sur le moment où la synchronisation a lieu et sur l'emplacement des approbations ou des restrictions dans le flux. | La communication d'intégration ou de lancement est ici le choix évident. Elle convient si les utilisateurs souhaitent comprendre rapidement les nouveautés et comment les mettre en pratique immédiatement. |
Rendre les informations complexes claires, compréhensibles et convaincantes
Comment visualiser des technologies complexes de manière compréhensible
Ne commencez pas par l'architecture, mais par l'événement : la soumission d'un formulaire, la création d'une commande ou la connexion d'un utilisateur. Montrez ensuite séparément ce que l'utilisateur voit et ce qui se passe en arrière-plan entre les systèmes. Des étiquettes simples, des flèches et des statuts sont souvent plus efficaces qu'un schéma technique. Pour des conseils d'expérience utilisateur sur les parcours utilisateurs, vous trouverez des tutoriels logiciels animés. Si le processus est plus abstrait que ce qui est affiché à l'écran, une présentation SaaS, une vidéo explicative technique ou une animation du processus seront plus appropriées qu'une simple capture d'écran.
De quelles contributions avez-vous besoin de la part des équipes de développement, de produit et d'opérations
- Décrivez le flux de travail réel, y compris les systèmes impliqués, les exceptions et les dépendances.
- Utilisez la documentation, les informations du SDK, les notes de version et les connaissances d'intégration comme sources, mais traduisez-les en langage visuel.
- Déterminez à l'avance à qui est destinée la vidéo : client, équipe de mise en œuvre, équipe commerciale ou formation interne.
- N’incluez les aspects liés à la sécurité, à la conformité et aux approbations que s’ils influencent le processus ou la décision.
Voici comment vérifier l'exactitude de l'explication avant publication
Ne testez pas une vidéo d'API à la dernière minute ; testez-la dès le storyboard et le script. Faites vérifier par les équipes produit et développement la séquence, la représentation précise des dépendances et la terminologie. Assurez-vous également auprès du public cible qu'il comprend bien le processus, les avantages et les responsabilités. Portez une attention particulière aux changements de statut, aux exceptions, aux approbations et aux points de transfert. En cas de modification du périmètre d'intégration, d'interface ou de version, mettez à jour la vidéo, notamment dans les environnements SaaS. Enfin, un processus d'intégration clair, grâce à des vidéos explicatives, peut contribuer à réduire les demandes d'assistance.
Votre question ne figure pas dans la liste ? N'hésitez pas à la poser.
Posez votre question
Prêt à passer de A à AA ?
Qu’il s’agisse d’une ambition, d’un produit, d’un processus, d’une technologie ou d’une idée : nous rendons visible ce qui le rend spécial et le traduisons en images claires, convaincantes et impossibles à ignorer.