API Manager Log Service API (Beta)

Einführung

Als Alternative zum Herunterladen einer API-Protokolldatei durch Klicken auf Download as CSV auf der API-Protokollseite können Sie eine API-Protokolldatei über eine REST-API abrufen. Dies erfordert die Verwendung von Befehlszeilen-Dienstprogrammen wie curl oder Anwendungen wie Postman.

Um die API Manager Log Service API (Beta) zu verwenden, aktivieren Sie zunächst API-Protokolle für die API Manager API und folgen Sie diesen Schritten:

1. Holen Sie sich ein Authentifizierungstoken über die User Service Controller API. Dieses Token ist erforderlich, um die API Manager Log Service API (Beta) zu verwenden.

   • Wenn Ihre Harmony Organisation keine Zwei-Faktor-Authentifizierung (TFA) aktiviert hat, holen Sie sich Ihr Authentifizierungstoken mit einer Standard-Anmeldeanforderung.

   • Wenn Ihre Harmony Organisation TFA aktiviert hat, erfordert das Abrufen des Authentifizierungstokens zwei Anfragen:

     1. Holen Sie sich einen TFA-Code

     2. Verwenden Sie den TFA-Code, um ein Authentifizierungstoken abzurufen

2. Holen Sie sich die Protokolldatei über die API Manager Log Service API (Beta).

Authentifizierungstoken abrufen

Das Abrufen eines Authentifizierungstokens erfordert die Verwendung der User Service Controller API.

Ein Beispiel für eine Anfrage, die das Anmelden in der NA-Region und das Abrufen des Autorisierungstokens zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!"
}'

Basis-URL

Die Basis-URL hängt von der Region ab, in der sich die Organisation befindet:

Header

Diese Header sind erforderlich:

Body-Parameter

Diese erforderlichen Parameter werden im Body der Anfrage übergeben:

Antwort-Body

Der zurückgegebene Antwort-Body enthält eine Liste der Organisationen, mit denen der Benutzer verbunden ist, zusätzlich zum Authentifizierungstoken ("authenticationToken"). Dieses Token ist für die nachfolgende Autorisierung mit der API Manager Log Service API (Beta) erforderlich. In diesem Beispiel ist das Authentifizierungstoken "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4". Die Organisations-ID wird als "123456" für die erste Organisation angezeigt, zu der dieser Benutzer gehört. Ein Beispiel für die Antwort:

{
  "status": true,
  "operation": "User login",
  "authenticationToken": "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4",
  "serverUrl": "https://na-east.jitterbit.com",
  "cloudAppsUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [
    {
      "orgId": "123456",
      "orgName": "JB Example Company",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    },
    {
      "orgId": "20970",
      "orgName": "example@jbexample.com",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    }
  ],
  "defaultOrgId": "123456",
  "sessionTimeoutInSeconds": 14400
}

Abrufen eines Authentifizierungstokens mit aktivierter TFA

Wenn die Organisation eines Benutzers in Harmony die Zwei-Faktor-Authentifizierung (TFA) aktiviert hat, erfordert das Abrufen des Authentifizierungstokens zwei Anfragen über die User Service Controller API:

1. TFA-Code abrufen

2. TFA-Code verwenden, um ein Authentifizierungstoken abzurufen

TFA-Code abrufen

Ein gültiger TFA-Code ist erforderlich, um ein Authentifizierungstoken abzurufen, wenn TFA aktiviert ist. Ein Beispiel für eine Anfrage, die das Anmelden in der NA-Region und das Anfordern eines TFA-Codes zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!",
    "deviceId": "abcd"
}'

Basis-URL

Die Basis-URL hängt von der Region ab, in der sich die Organisation befindet:

Header

Diese Header sind erforderlich:

Körperparameter

Diese erforderlichen Parameter werden im Körper der Anfrage übergeben:

Antwortkörper

Der zurückgegebene Antwortkörper enthält eine Fehlermeldung, die angibt, dass ein TFA-Code an die Email-Adresse des Benutzers gesendet wurde.

{
  "status": false,
  "operation": "User login",
  "errorCode": "VALIDATE_TFA_LOGIN_EMAIL",
  "errorMessage": "Validate your login with authentication code. An email from Jitterbit with the code was sent to you.",
  "authenticationToken": null,
  "serverUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [],
  "defaultOrgId": null
}

Verwenden Sie den TFA-Code, um ein Authentifizierungstoken abzurufen

Der an die Email-Adresse des Benutzers gesendete TFA-Code kann nun in der zweiten Anfrage verwendet werden, um das Authentifizierungstoken abzurufen. Ein Beispiel für eine Anfrage, die das Anmelden in der NA-Region mit einem TFA-Code und das Abrufen des Autorisierungstokens zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/user/login/tfacode' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "alice@jbexample.com",
    "password": "Jitterbit4Ever!",
    "code": "112233",
    "deviceId": "abcd"
}'

Basis-URL

Die Basis-URL hängt von der Region ab, in der sich die Organisation befindet:

Header

Diese Header sind erforderlich:

Körperparameter

Diese erforderlichen Parameter werden im Körper der Anfrage übergeben:

Antwortkörper

Der zurückgegebene Antwortkörper enthält eine Liste der Organisationen, mit denen der Benutzer verbunden ist, zusätzlich zum Authentifizierungstoken ("authenticationToken"). Dieses Token ist erforderlich für die nachfolgende Autorisierung mit der API Manager Log Service API (Beta). In diesem Beispiel ist das Authentifizierungstoken "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4". Die Organisations-ID wird als "123456" für die erste Organisation angezeigt, zu der dieser Benutzer gehört. Ein Beispiel für die Antwort:

{
  "status": true,
  "operation": "User login",
  "authenticationToken": "1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4",
  "serverUrl": "https://na-east.jitterbit.com",
  "cloudAppsUrl": "https://na-east.jitterbit.com",
  "orgAttrs": [
    {
      "orgId": "123456",
      "orgName": "JB Example Company",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    },
    {
      "orgId": "654321",
      "orgName": "example@jbexample.com",
      "orgZoneUrl": "https://na-east.jitterbit.com"
    }
  ],
  "defaultOrgId": "123456",
  "sessionTimeoutInSeconds": 14400
}

API-Protokolle asynchron abrufen (Beta)

Sobald Sie das Authentifizierungstoken und die Organisations-ID haben, können Sie API-Protokolle asynchron mit der API Manager Log Service API (Beta) abrufen. Ein Beispiel, das das Abrufen aller Datensätze vom 20. Januar 2023 bis zum 20. Januar 2024 zeigt:

curl --location --request PUT 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/api/analytics/debuglogs-async' \
--header 'Content-Type: application/json' --header 'Accept: application/json' --header 'authToken: 1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4' \
--data-raw '{
    "ascendSort": false,
    "retrieveLogMessages": false,
    "timeRangeFrom": "01/20/2023 01:01:00 +0100",
    "timeRangeTo": "01/20/2024 01:01:00 +0100",
    "clientTimeZone": "Europe/Berlin",
    "queryString": "responsetime>5; sourceip=14.141%",
    "orgId": "123456",
    "csvFormat": true
}'

Basis-URL

Die Basis-URL hängt von der Region ab, in der sich die Organisation befindet:

Header

Diese Header können in der Anfrage verwendet werden:

Body-Parameter

Diese Parameter können im Body der Anfrage übergeben werden:

Antwortkörper

Wenn erfolgreich, enthält der zurückgegebene Antwortkörper einen Referenzschlüssel zur Verfolgung und zum Herunterladen der API-Protokolldatei basierend auf den bereitgestellten Parametern:

{
    "key": "debug-log-E8D47FE1F172D3EE46C620791E614B78D111CE624485D2E1B3D482370690DC40",
    "status": "COMPLETE"
}

Der Referenzschlüssel kann dann als Teil des folgenden API-Aufrufs bereitgestellt werden, um den Status der Protokolldatei zu überprüfen oder sie herunterzuladen, wenn der Status VOLLSTÄNDIG ist:

curl --location --request GET 'https://na-east.jitterbit.com/jitterbit-cloud-restful-service/api/analytics/log-async/{orgId}/{key}' \
--header 'Content-Type: application/json' --header 'Accept: application/json' --header 'authToken: 1_70dfe7f7-1d47-4ad5-be5d-bc4a222dd2g4'

Mögliche Status sind:

• EMPFANGEN: Harmony hat eine gültige Anfrage zum Generieren der Protokolldatei erhalten. Der Status wechselt zu VERARBEITEN, wenn die Anfrage ausgeführt wird.
• VERARBEITEN: Die Protokolldatei wird generiert. Der Status wechselt zu VOLLSTÄNDIG, wenn die Dateigenerierung abgeschlossen ist.
• VOLLSTÄNDIG: Die Protokolldatei ist bereit zum Herunterladen mit der oben genannten log-async API.
• UNGÜLTIG: Der Referenzschlüssel konnte nicht gefunden werden. Dieser Status wird nur gemeldet, wenn ein unbekannter oder fehlerhafter Referenzschlüssel an die log-async API übergeben wird.
• FEHLER: Der Referenzschlüssel wurde gefunden, nachdem die API versucht hatte, die Protokolldatei zu generieren, aber ein Fehler wurde gemeldet. Eine Fehlermeldung wird ebenfalls zurückgegeben, die erläutert, warum die Generierung fehlgeschlagen ist.
• KEINE_DATEN: Die Filterparameter, die Daten im ursprünglichen API-Aufruf abfragen, haben 0 Ergebnisse zurückgegeben.