Verwenden des Trados GroupShare Webhooks-Dienstes

Erfahren Sie, wie Sie den Trados GroupShare Webhooks-Dienst konfigurieren und verwenden.

Webhooks-Dienst konfigurieren

So konfigurieren Sie den Webhooks-Dienst:

Prozedur

  1. Gehen Sie zu C:\Programme\SDL\SDL Server\WebHooks Service.
  2. Bearbeiten Sie Sdl.GroupShare.WebHooksService.exe.config. Die relevanten Einstellungen sind unten aufgeführt:
    <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>
    Achten Sie auf die Konfiguration, die für den Überwachungs-Port des Dienstes, die RabbitMQ-Meldungswarteschlange und die Datenbank verwendet wird, in der die Webhook-Registrierungen gespeichert werden.
    • RestHostUrl Die Host- und Port-Einstellung, die der Webhooks-Dienst für die Überwachung verwendet.
    • MessageQueueHost, MessageQueueUserName, MessageQueuePassword werden vom Installationsprogramm von Trados GroupShare konfiguriert und sind erforderlich, um Meldungen von RabbitMQ zu konsumieren.
    • WebHookQueueName, WebHookQueueDeadLetterName, WebHookQueueDLXName werden verwendet, um die Warteschlangen anzugeben, aus denen Meldungen konsumiert werden sollen. Es wäre möglich, neue Warteschlangen mit unterschiedlichen Routing-Schlüsseln zu erstellen. Wir empfehlen, sie so zu belassen.
    • Server – der Wert der Server-Einstellung wird in den Haupttext der Rückruf-Anforderung aufgenommen, um den Webhook-Absender der Meldung zu ermitteln.

Ereignisse abonnieren

Sie können alle vorhandenen Ereignisse abonnieren, indem Sie den Filter "*" und eine einzige Rückruf-Behandlungs-URL verwenden.

Warum und wann dieser Vorgang ausgeführt wird

Folgende Filtertypen stehen zur Verfügung:

  • 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
  • *

Interaktion mit dem REST API-Endpunkt

Die Interaktion mit dem Trados GroupShare Webhooks-Dienst erfolgt über REST API-Aufrufe, die mit Bearer-Tokens gesichert sind (die Sie mit dem Trados GroupShare Management REST API-Anmeldeendpunkt erhalten).

Warum und wann dieser Vorgang ausgeführt wird

Weitere Informationen finden Sie unter REST API-Endpunkt des Webhooks-Dienstes.

Empfangen von Webhooks-Benachrichtigungen (Rückrufe)

Nachdem eine WebHook-URI für ein bestimmtes Ereignis registriert wurde, erhalten Sie Rückrufe, wenn dieses Ereignis eintritt. Der Rückruf ist eine POST-Anforderung.

Warum und wann dieser Vorgang ausgeführt wird

Weitere Informationen finden Sie unter Webhooks-Benachrichtigungen (Rückrufe).

REST API-Endpunkte testen

Um REST API-Endpunkte zu testen/auszuprobieren, verwenden Sie die Postman-Sammlung.

Warum und wann dieser Vorgang ausgeführt wird

Laden Sie die ZIP-Datei für die -Sammlung herunter und extrahieren Sie sie.