Utiliser des webhooks dans DocSpace

Premièrement, il faut configurer le point de terminaison pour webhooks au sein du service externe. Le point de terminaison sert à écouter des webhooks DocSpace et recevoir des notifications d'événement.

Une fois le point de terminaison créé et configuré, vous pouvez créer des webhooks dans DocSpace. Pour créer un nouveau webhook,

1. Utilisez le menu dans le coin inférieur gauche et sélectionnez l'option Paramètres.
2. Dans la section Paramètres DocSpace, accédez à la section Outils développeur de gauche.
3. Passez à la section Webhook.
4. Cliquez sur le bouton Create webhook (Créer un webhook).
5. Configurez les paramètres nécessaires:
   • Nom du webhook - un nom identifiant pour faciliter le travail avec le webhook sur le portail.
   • URL de la charge - l'adresse du point de terminaison sur laquelle le webhook doit être envoyé.
   • Clé secrète - indiquez le secret du webhook permettant de vérifier les requêtes envoyées vers l'URl de la charge utile. Saisissez votre clé ou cliquez sur Generate (Générer). Remarque: une fois la clé sauvegardée, il sera impossible de la récupérer. Si la clé privée est oubliée ou perdue, vous pouvez la réinitialiser mais on doit mettre à jour toutes les applications d'intégration protégées par cette clé.
   • Vérification SSL - par défaul, cette option est activée pour vérifier les certificats SSL lors de la remise de la charge utile. Il n'est pas recommandé de désactiver ce paramètre.
6. Cliquez sur le bouton Créer.

Le webhook que vous avez créé sera associé à tous événements sur DocSpace. Les notifications d'événements DocSpace seront envoyées automatiquement vers le service externe.

Vous pouvez désactiver ou réactiver un webhook en utilisant le curseur à côté. Utilisez l'icône à droite pour modifier les paramètres de webhook que vous avez indiqué lors de la création, afficher l'historique du webhook ou supprimer le webhook.

Lorsque vous affichez l'historique, vous pouvez filtrer des webhooks par date de livraison ou statut (N'est pas envoyé, 2XX, 3XX, 4XX, 5XX). Cliquez sur le bouton filtre , sélectionnez les paramètres nécessaires et cliquez sur Apply (Appliquer).

Vous pouvez sélectionner un ou plusieurs webhooks de la liste et utilisez l'option Réessayer qui s'affiche en haut pour redélivrer les webhooks sélectionnés. Ou cliquez sur l'icône à côté du webhook et sélectionnez l'option Réessayer dans le menu contextuel.

Cliquez sur l'icône à côté du webhook et sélectionnez l'option Détails du webhook dans le menu contextuel.

Les détails suivantes sont disponibles:

• Status (Statut) - le statut d'une réponse.
• Event ID (ID d'événement) - l'identifiant de l'événement.
• Event time (Heure de l'événement) - la date à laquelle l'événement s'est produit.
• Delivery time (Date de livraison) - la a date à laquelle le webhook a été envoyé vers le point de terminaison.

Dans la section Demande/Réponse, vous pouvez également afficher l'en-tête de la requête POST, le corps de la requête POST, l'en-tête de la réponse POST et le corps de la requête POST. Utiliser l'icône pour copier l'en-tête/le corps de la demande ou de la réponse dans le presse-papiers.

Utilisez l'icône à côté de l'inscription Détails de webhook pour relivrer le webhook.

Les deux services qui sont utilisés sont les suivants:

1. ASC.Web.Studio fournit des méthodes pour envoyer des webhooks et lance WorkerService.

   WorkerService - permet de s'abonner pour recevoir des messages à partir du répartiteur (par exemple, kafka) qui sauvegarde les informations sur les envois en attente. Les messages à partir du répartiteur sont mis dans la file d'attente, et ensuite les demandes d'envoi des webhooks sont constamment envoyés vers cette file d'attente et établit une communication asynchrone avec ASC.Webhoks.Service pour envoyer des webhooks.

2. ASC.Webhooks.Core fournit des méthodes pour publier des webhooks et des méthodes de travailler avec la base de donnée dans la base de donnée et dans le répartiteur de messages.

Actuellement, un webhook résulte de toute demande adressée à l'API, telle que post, update et delete.

Pour en savoir plus sur DocSpace API, veuillez visiter api.onlyoffice.com.