Zum Inhalt springen

Connector SDK REST APIs

Übersicht

Diese APIs stehen zur Verfügung, um Connectoren zu registrieren und zu verwalten, die mit dem Connector SDK erstellt wurden. Beispiele für die Verwendung dieser APIs mit Postman sind auf der Registrierung Seite zu finden.

Methode Beschreibung
Benutzer anmelden In Harmony anmelden
Connector registrieren Einen benutzerdefinierten Connector registrieren
Registrierte Connectoren auflisten Registrierte Connectoren auflisten
Registrierung löschen Eine Connector-Registrierung löschen
Payload löschen Einen Connector-Payload löschen
Connector-Schlüssel/Geheimnis validieren Einen Connector-Schlüssel und -Geheimnis validieren

Hinweis

Um einen Connector vollständig aus einer Organisation zu löschen, müssen sowohl die Registrierung als auch der JSON-Payload gelöscht werden. Sie können nur die Connectoren löschen, die in keinem Projekt der Organisation verwendet werden.

Basis-URL

Alle unten aufgeführten APIs verwenden eine Basis-URL, die aus

{hostURL}/jitterbit-cloud-restful-service/

besteht, wobei

  • {hostURL}: Die Jitterbit-Region-Host-URL, wie https://na-east.jitterbit.com

Jede für jede API angegebene URL mit dieser Basis-URL (dargestellt durch {baseURL}) voranstellen. Um zu bestimmen, in welcher Region sich Ihre Organisation befindet, siehe Meine Region finden.

Die Host-URL für jede Region wird in dieser Tabelle angegeben:

Region Host-URL
NA https://na-east.jitterbit.com
EMEA https://emea-west.jitterbit.com
APAC https://apac-southeast.jitterbit.com

Authentifizierung

Neben der Basis-URL wird bei allen unten aufgeführten APIs – mit Ausnahme von Anmelden bei Harmony – davon ausgegangen, dass ein Authentifizierungstoken als einer der Header in der Anfrage übergeben wird. Dieses Token kann durch die Verwendung der ersten API erhalten werden, indem das Token aus der Antwort extrahiert wird.

Anfrage-Header

Mit Ausnahme von Anmelden bei Harmony müssen alle unten aufgeführten APIs diese Anfrage-Header (neben allen für eine bestimmte API beschriebenen Headern) enthalten:

Content-Type: application/json
authToken: {authToken}

wobei

Anmelden bei Harmony

Meldet sich bei Harmony an. Verwenden Sie diese API, um das Authentifizierungstoken zu erhalten, das für die Nutzung der anderen auf dieser Seite aufgeführten APIs erforderlich ist.

PUT {baseURL}/user/login

wobei

Anfrage-Header

  • Content-Type: application/json

Anfrage-Body

Der Body der Anfrage muss Folgendes enthalten:

{
  "email": "{email}",
  "password": "{password}"
}

wobei

  • {email}: Der Benutzername (E-Mail-Adresse), der mit dem Harmony-Login verknüpft ist
  • {password}: Das Passwort für den Benutzernamen

Antwort

Der Body der Antwort wird eine JSON-Zeichenfolge enthalten, die ein authenticationToken enthält. Dieses Token muss als authToken-Header bei nachfolgenden API-Aufrufen übergeben werden und authentifiziert diese Aufrufe.

Registrieren eines benutzerdefinierten Connectors

Registriert einen Connector und erhält die IDs, die für die Manifestdatei des Connectors erforderlich sind. Führen Sie diese API aus, bevor Sie die JAR-Datei des Connectors paketieren.

POST {baseURL}/orgs/{orgId}/connector

wobei

  • {baseURL}: Die Basis-URL, wie oben beschrieben
  • {orgId}: Organisations-ID der Harmony-Organisation, in der der Connector registriert ist

Anfrage-Header

Anfragekörper

Der Körper der Anfrage muss Folgendes enthalten:

{
    "name": "{connectorName}",
    "version": "{connectorVersion}"
}
wobei

  • {connectorName}: Der Name des Connectors
  • {connectorVersion}: Die Version des Connectors

Antwort

Der Körper der Antwort enthält eine JSON-Zeichenfolge mit den IDs, dem Schlüssel und dem Geheimnis, die für die Manifestdatei des Connectors erforderlich sind. Zum Beispiel:

{
    "status": true,
    "operation": "Register a connector",
    "id": "4471",
    "key": "6d093654-d...2-10cad6797d6e",
    "secret": "3673e11b-f...d-5e3f3ad796d5",
    "endpointEntityId": "2370701",
    "functionEntityStartId": "2370702",
    "functionEntityEndId": "2370800"
}

Liste registrierter Connectoren

Listet alle benutzerdefinierten Connectoren (die mit dem Connector SDK oder dem Connector Builder erstellt wurden), die bei einer bestimmten Organisation registriert sind.

GET {baseURL}/orgs/{orgId}/connector

wobei

  • {baseURL}: Die Basis-URL, wie oben beschrieben
  • {orgId}: Organisations-ID der Harmony-Organisation, in der der Connector registriert ist

Anfrageheader

Antwort

Der Körper der Antwort enthält eine JSON-Zeichenfolge mit einer Liste registrierter Connectoren. Dieses Beispiel zeigt eine Organisation mit dem registrierten Beispiel-Connector Dropbox:

{
    "status": true,
    "operation": "List registered connectors",
    "registeredConnectorList": [
        {
            "id": "4471",
            "name": "Dropbox",
            "version": "1.0.0",
            "key": "6d093654-d...2-10cad6797d6e",
            "secret": "3673e11b-f...d-5e3f3ad796d5",
            "endpointEntityId": "2370701",
            "functionEntityStartId": "2370702",
            "functionEntityEndId": "2370800"
        }
    ]
}

Löschen einer Connector-Registrierung

Löscht die Registrierung eines benutzerdefinierten Connectors. Diese API wird nur erfolgreich sein, wenn der Connector in keinem Projekt der Organisation verwendet wird. Um die JSON-Nutzlast (die JSON-Datei, die die UI beschreibt, die im Manifest-Eintrag Jitterbit-Connector-UI angegeben ist) eines benutzerdefinierten Connectors zu löschen, verwenden Sie die API, um eine Connector-Nutzlast zu löschen.

DELETE {baseURL}/orgs/{orgId}/connector/{connectorId}

wobei

  • {baseURL}: Die Basis-URL, wie oben beschrieben
  • {orgId}: Organisations-ID der Harmony-Organisation, in der der Connector registriert ist
  • {connectorId}: Connector-ID, die bei der Registrierung des Connectors erhalten wurde

Anfrageheader

Löschen eines Connector-Payloads

Löscht das JSON-Payload (die JSON-Datei, die die UI beschreibt, angegeben im Manifest-Eintrag Jitterbit-Connector-UI) eines benutzerdefinierten Connectors. Das Payload wird in Harmony zwischengespeichert, um die Integration Studio UI des Connectors darzustellen. Diese API wird nur erfolgreich sein, wenn der Connector in keinem Projekt der Organisation verwendet wird. Um die Registrierung eines benutzerdefinierten Connectors zu löschen, verwenden Sie die API, um die Registrierung eines Connectors zu löschen.

DELETE {baseURL}/orgs/{orgId}/connector/{connectorId}/sdk/delete

wo

  • {baseURL}: Die Basis-URL, wie oben beschrieben
  • {orgId}: Organisations-ID der Harmony-Organisation, in der der Connector registriert ist
  • {connectorId}: Connector-ID, die bei der Registrierung des Connectors erhalten wurde

Anfrage-Header

Validieren eines Connector-Schlüssels und -Secrets

Validiert ein Paar aus Connector-Schlüssel und -Secret.

PUT {baseURL}/orgs/{orgId}/connector/validate/securityinfo

wo

  • {baseURL}: Die Basis-URL, wie oben beschrieben
  • {orgId}: Organisations-ID der Harmony-Organisation, in der der Connector registriert ist

Anfrage-Header

Anfrage-Body

Der Body der Anfrage muss enthalten:

{
    "name": "{connectorName}",
    "key": "{key}",
    "secret": "{secret}"
}

wo

  • {connectorName}: Der Name des Connectors
  • {key}: Der Schlüssel, der mit dem Connector dieses Namens verbunden ist
  • {secret}: Das Secret, das mit dem Connector dieses Namens verbunden ist