Verwenden der API

Willkommen bei der Communications Mining-API. Unser Ziel ist es, die API vorhersehbar, einfach zu verwenden und einfach zu integrieren. Wenn Sie glauben, dass wir etwas verbessern können, oder wenn Fehler oder unerwartetes Verhalten auftreten, wenden Sie sich bitte an den Support . Wir werden uns so schnell wie möglich bei Ihnen melden.

Sie können alle verfügbaren Endpunkte in der API-Referenz sehen. Es gibt auch ein API-Tutorial.

API-Endpunkt

Alle API-Anforderungen werden als JSON-Objekte über HTTPS an Communications Mining an Ihren Mandantenendpunkt gesendet.

Mandanten mit Onboarding über UiPath:

https://cloud.uipath.com/<my_uipath_organisation>/<my_uipath_tenant>/reinfer_/api/...

Über Communications Mining integrierte Mandanten:

https://<mydomain>.reinfer.io/api/...

Wichtig:

ENTWICKLUNGS- UND Productionsumgebungen

In Communications Mining können Entwicklungs- und Produktionsdaten und -Workflows getrennt werden, entweder durch separate Mandanten oder durch Platzierung in separaten Projekten im selben Mandanten. In jedem Fall wird der Datenzugriff separat genehmigt (sodass Entwickler Administratorzugriff auf Entwicklungsdaten haben, während die Produktion strengere Kontrollen durchführen kann). Wenn separate Mandanten verwendet werden, unterscheidet sich der API-Endpunkt bei jedem von Entwicklungs- und Produktionsdaten; Wenn separate Projekte im selben Mandanten verwendet werden, wird der Endpunkt dieses einzelnen Mandanten für beide verwendet.

Authentication

Alle API-Anforderungen erfordern eine Authentifizierung, um den Benutzer zu identifizieren, der die Anforderung stellt. Die Authentifizierung wird über ein Zugriffstoken bereitgestellt. Das Entwicklerzugriffstoken kann auf der Seite Konto verwalten abgerufen werden.

Hinweis:

Es kann jeweils nur ein API-Token aktiv sein. Das Generieren eines neuen Tokens macht das vorherige ungültig.

Sie müssen den folgenden HTTP-Header für jeden API-Aufruf einschließen, wobei $REINFER_TOKEN Ihr Communications Mining API-Token ist.

Authorization: Bearer $REINFER_TOKEN

Die Bash-Beispiele in der API-Referenz gehen davon aus, dass Sie Ihr Token in einer Umgebungsvariablen gespeichert haben. Die Python- und Knotenbeispiele in der API-Referenz gehen davon aus, dass das Token in einer lokalen Variablen REINFER_TOKEN über die von Ihnen gewählte Konfigurationslösung gespeichert wurde.

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/...' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• Knoten

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/...",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.get(
      "https://<my_api_endpoint>/api/...",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Antwort

  {
    "status": "ok"
  }

Berechtigungen

Für jeden API-Endpunkt in der API-Referenz sind die erforderlichen Berechtigungen aufgeführt. Sie können die Berechtigungen, die Sie haben, auf Ihrer Seite Konto verwalten anzeigen. Die Seite zeigt die Projekte an, auf die Sie Zugriff haben, und die Berechtigungen , die Sie in jedem Projekt haben.

Fehler

Wir verwenden herkömmliche HTTP-Antwortcodes, um Erfolg oder Fehler einer API-Anforderung anzuzeigen. Im Allgemeinen zeigen Codes im Bereich 2xx einen Erfolg an, Codes im Bereich 4xx zeigen einen Fehler an, der aus der bereitgestellten Anforderung resultierende ist, und Codes im Bereich 5xx weisen auf ein Problem mit der Communications Mining-Plattform hin.

Fordert an, dass der Fehler auch einen Text mit einem status -Wert von error anstelle von ok und eine Fehlermeldung zurückgibt, die den Fehler beschreibt.

• Bash

  curl -X GET 'https://<my_api_endpoint>/api/v1/nonexistent_page' \
      -H "Authorization: Bearer $REINFER_TOKEN"

• Knoten

  const request = require("request");
  
  request.get(
    {
      url: "https://<my_api_endpoint>/api/v1/nonexistent_page",
      headers: {
        Authorization: "Bearer " + process.env.REINFER_TOKEN,
      },
    },
    function (error, response, json) {
      // digest response
      console.log(JSON.stringify(json, null, 2));
    }
  );

• Python

  import json
  import os
  
  import requests
  
  response = requests.get(
      "https://<my_api_endpoint>/api/v1/nonexistent_page",
      headers={"Authorization": "Bearer " + os.environ["REINFER_TOKEN"]},
  )
  
  print(json.dumps(response.json(), indent=2, sort_keys=True))

• Antwort

  {
    "message": "404 Not Found",
    "status": "error"
  }

Beachten Sie, dass Ihre Anforderung aufgrund von Problemen in Ihrem Netzwerk fehlschlagen kann, bevor sie Communications Mining erreicht. In solchen Fällen unterscheidet sich die Antwort, die Sie erhalten, von der oben beschriebenen Communications Mining-Fehlerantwort.

Leistungs-Timing

Wir verwenden den Server-Tiging-HTTP-Header , um die Zeit zu kommunizieren, die für die Verarbeitung von Anfragen an unsere API benötigt wurde. Wir fügen eine einzelne Metrik hinzu, total, mit der Sie messen können, wie lange unsere Plattform brauchte, um Ihre Anfrage frei von Latenz der Netzwerkanforderung zu bearbeiten.

Ein Beispiel für den Header, wie er in einer Antwort zu sehen ist:

Server-Timing: total;dur=37.7

Server-Timing -Werte werden immer in Millisekunden angegeben. In diesem Fall dauerte die API-Anforderung mit diesem Header-Wert 37,7 Millisekunden, um auf unserer Plattform zu verarbeiten.