Cargogear

Monitoring

Das Monitoring-Feature besteht aus zwei Elementen: Der API zur Überwachung produktiver Datenströme und dem Reporting für den Feedback-Prozess.

Requests senden

Senden eines einfachen Test-Requests

Voraussetzung
  • Sie haben einen gültigen API-Schlüssel.
  • Sie haben eine Prüfschnittstelle lizenziert und kennen deren Schnittstelle und Prozessnamen.
  • Sie kennen Ihre Mandanten-ID (Sie erhalten sie bei der Erstellung Ihres Cargogear-Mandanten).
  • Sie haben eine Testnachricht für die ausgewählte Prüfschnittstelle.
  • Sie haben eine E-Mail-Adresse für die Berichterstellungsemail.
  • Wir empfehlen die Verwendung eines API-Testtools.
Schritte
  1. Öffnen Sie das API-Test-Tool Ihrer Wahl.
  2. Erstellen Sie einen neuen Request und wählen Sie POST als HTTP-Aktion aus.
  3. Ersetzen Sie PLACEHOLDER_INSTANCE in der folgenden URL durch den Namen Ihrer Cargogear-Instanz. Ersetzen Sie PLACEHOLDER_FORMAT durch die Werte 'edifact' oder 'xml', je nachdem, welches Format Sie validieren möchten. Fügen Sie dann die angepasste URL in Ihren Request ein:
    https://PLACEHOLDER_INSTANCE.cargogear.io/validation_exec/api/v1/reports/PLACEHOLDER_FORMAT/generate/json
  4. Setzen Sie im Abschnitt Header 'x-api-key' als Header und den API-Schlüssel als Wert.
    Wenn nicht automatisch von Ihrem API-Test-Tool gesetzt, setzen Sie 'application/json' als Wert für den Header 'Content-Type'.
  5. Im Abschnitt Body setzen Sie das folgende JSON-Dokument ein und ersetzen die Platzhalter durch reale Werte.
    • message_type: Ein String mit dem Namen der Prüfschnittstelle. Bitte überprüfen Sie auf Tippfehler!
    • process: Ein String mit dem Prozessnamen der Prüfschnittstelle. Bitte überprüfen Sie auf Tippfehler!
    • content: Ein String ohne Zeilenumbrüche, der die Testnachricht enthält.
    • email_receivers: Ein Array von Adressen, an die eine Benachrichtigungs-E-Mail gesendet wird, wenn die Nachricht Mängel aufwies. Jedes Element ist vom Typ „address“.
    • address: Ein String mit der E-Mail-Adresse, an die die Benachrichtigungs-E-Mail gesendet werden soll. 
    {
  "message_type": "MY_INTERFACE_NAME",
  "process": "MY_PROCESS_NAME",
  "content": "THE_MESSAGE",
  "email_receivers": [ { "address": "test@test.com" } ]
}
  6. Senden Sie den Request.
Sie sollten den HTTP-Statuscode 200 erhalten.
Für jeden anderen Statuscode überprüfen Sie bitte die Antwort und passen Sie den Request entsprechend an.

Hinzufügen von Identifikatoren zu einem Validierungs-Request

Sie können Identifikatoren zu Ihren Requests hinzufügen, um das Ergebnis zu verarbeiten, z. B. in Ihrem EDI-System. Wenn Sie beispielsweise eine Referenz-ID hinzufügen, könnten Sie diese Informationen verwenden, um ein Validierungsergebnis einem EDI-Workflow zuzuweisen, der aufgehalten wird, bis Sie dieses Ergebnis erhalten. Dies ist die Liste der verfügbaren Referenzen:
  • file_name: Ein String, der den Dateinamen oder virtuellen Dateinamen enthalten sollte, wie Sie ihn erhalten oder während der EDI-Übertragung erstellt haben.
  • partner_ref_ext: Ein String mit einem technischen oder geschäftlichen Identifikator für den Datensender. Beispiel: Eine Lieferantennummer. Bitte beachten Sie: Wir verwenden diesen Wert, um einen Partner in der Cargogear-Plattform zu identifizieren. Stellen Sie daher sicher, dass Sie für jeden Partner eindeutige Werte verwenden.
  • partner_ref_int: Ein String, der einen zusätzlichen Identifikator für einen Partner enthalten könnte. Beispiel: Ein einzelner Standort eines Lieferanten.
  • ref_id: Ein String zur Identifizierung einer einzelnen Nachricht wie einer Dokumenten-ID oder einer Rechnungsnummer. 
{
  "message_type": "MY_INTERFACE_NAME",
  "process": "MY_PROCESS_NAME",
  "content": "THE_MESSAGE",
  "partner_ref_ext": "ARBITRARY_REF_EXTERNAL",
  "partner_ref_int": "ARBITRARY_INTERNAL_IDENTIFIER",
  "ref_id": "ID_TO_FIND_IT",
  "email_receivers": [ { "address": "test@test.com" } ]
}

Berichterstellung

Voraussetzung
  • Der vorherige Validierungsrequest enthielt eine oder mehrere E-Mail-Adressen, an die der Bericht gesendet werden soll.
Schritte
  1. Senden Sie den Request wie oben beschrieben.
  2. Wenn sie einen oder mehrere Fehler enthielt, wird eine E-Mail an den/die Empfänger gesendet. Wenn die Nachricht fehlerfrei war, wird keine E-Mail gesendet.
  3. Klicken Sie in der E-Mail auf die Schaltfläche "Im Web-Viewer öffnen" oder "Als HTML herunterladen".
Sie können den Fehlerbericht analysieren.
Bitte beachten: Die Links in der E-Mail sind 7 Tage lang gültig. Um eine Beschreibung der Fehler zu erhalten, siehe hier.

Haben Sie eine Frage?

Kontaktieren Sie uns
Impressum / DatenschutzHaftungsausschluss