Travailler avec le service WebHooks Trados GroupShare

Découvrez comment configurer et utiliser le service WebHooks Trados GroupShare.

Configuration du service WebHooks

Pour configurer le service WebHooks :

Procédure

  1. Accédez à C:\Program Files\SDL\SDL Serveur\Service WebHooks.
  2. Modifiez GroupShare.WebHooksService.exe.config. Les paramètres pertinents sont affichés ci-dessous :
    <appSettings>
      <add key="RestHostUrl" value="http://+:41239" />
      <add key="MessageQueueHost" value="localhost" />
      <add key="MessageQueueUserName" value="gssvc" />
      <add key="MessageQueueUserPassword" value="u5F/lWdnD+snwvYcjKv/Fg==" />
      <add key="WebHookQueueName" value="GsWebHookQueue" />
      <add key="WebHookQueueDeadLetterName" value="GsWebHookQueueDeadLetter" />
      <add key="WebHookQueueDLXName" value="GsWebHookDlx" />
      <add key="Server" value="gs-test-url.sdltest.com" />
      <add key="serilog:write-to:RollingFile.pathFormat" value="C:\ProgramData\SDL\Service\logs\WebHooks.Log" />
    </appSettings>
    <connectionStrings>
      <add name="MS_SqlStoreConnectionString" connectionString="Server=(local)\sqlserver2014;Database=WebHooks;Trusted_Connection=True;" providerName="System.Data.SqlClient" />
    </connectionStrings>
    Observez la configuration utilisée pour le port d'écoute du service, la file d'attente de messages RabbitMQ et la base de données où les enregistrements des web hooks seront stockés.
    • RestHostUrl est le paramètre d'hôte et de port que le service Web Hooks utilisera pour être activé.
    • MessageQueueHost, MessageQueueUserName, MessageQueuePassword sont configurés par le programme d'installation de Trados GroupShare et sont nécessaires pour consommer les messages de RabbitMQ.
    • WebHookQueueName, WebHookQueueDeadLetterName et WebHookQueueDLXName sont utilisés pour spécifier les files d'attente à partir desquelles consommer les messages. Il serait possible de créer de nouvelles files d'attente avec des clés de routage différentes. Nous vous conseillons de le laisser tel quel.
    • Server : la valeur du paramètre Server sera incluse dans le corps de la requête de rappel, afin de savoir qui a envoyé le message.

Abonnement aux événements

Vous pouvez vous abonner à tous les événements existants en utilisant le filtre « * » et une URL de gestion unique.

Pourquoi et quand exécuter cette tâche

Les types de filtre disponibles sont les suivants :

  • Sdl.GroupShare.Events.V2.ProjectCreatedEvent
  • Sdl.GroupShare.Events.V2.PhaseChangeEvent
  • Sdl.GroupShare.Events.V2.AssignmentEvent
  • Sdl.GroupShare.Events.V2.CheckOutEvent
  • Sdl.GroupShare.Events.V2.CheckInEvent
  • *

Interaction avec le point de terminaison de l'API REST

L'interaction avec le service WebHooks de Trados GroupShare se fait par le biais d'appels d'API REST, sécurisés par des jetons d'authentification (que vous obtenez à l'aide du point de terminaison de connexion de l'API REST de Trados GroupShare Management).

Pourquoi et quand exécuter cette tâche

Consultez la rubrique Point de terminaison de l'API REST du service WebHooks pour plus d'informations.

Réception de notification par WebHooks (rappels)

Après qu'un URI WebHook a été enregistré pour un certain événement, vous recevrez des notifications lorsque cet événement se produira. Le rappel est une requête POST.

Pourquoi et quand exécuter cette tâche

Consultez la rubrique Notification de WebHooks (rappels) pour plus d'informations.

Test des points de terminaison de l'API REST

Pour tester / essayer les points de terminaison de l'API REST, utilisez la collection Postman.

Pourquoi et quand exécuter cette tâche

Téléchargez et extrayez le fichier ZIP de la collection .