Zum Inhalt springen

Connector-SDK-REST- APIs

Übersicht

Diese APIs stehen für die Registrierung und Verwaltung von Konnektoren zur Verfügung, die mit dem Connector SDK erstellt wurden. Beispiele für die Verwendung Diese APIs mit Postman werden auf der Registrierung Seite.

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

Hinweis

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

Basis URL

Alle unten aufgeführten APIs verwenden eine Basis URL bestehend aus

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

wobei

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

Stellen Sie jeder URL für jede API diese Basis URL voran (dargestellt durch {baseURL}). Um zu ermitteln, in welcher Region Ihre Organisation liegt, lesen Sie Meine Region suchen.

Die Host URL für jede Region ist 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

Zusätzlich zur Basis URL, alle unten aufgeführten APIs - mit Ausnahme von Bei Harmony anmelden---angenommen, ein Authentifizierungstoken wird als ein der Header in der Anfrage. Dieses Token kann durch Verwendung der ersten API erhalten werden und Extrahieren des Tokens aus seiner Antwort.

Anforderungsheader

Mit Ausnahme von Bei Harmony anmelden, alle unten aufgeführten APIs sind um diese Anforderungsheader einzuschließen (zusätzlich zu allen Headern, die für eine bestimmte API beschrieben sind):

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

wobei

Bei Harmony anmelden

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

PUT {baseURL}/user/login

wobei

Anforderungsheader

  • Content-Type: application/json

Anforderungstext

Der Text der Anfrage muss enthalten:

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

wobei

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

Antwort

Der Hauptteil der Antwort ist eine JSON-Zeichenfolge mit einem authenticationToken. Dieses Token wird weitergegeben als authToken Header nachfolgender API Aufrufe und authentifiziert diese Aufrufe.

Registrieren eines benutzerdefinierten Connectors

Registriert einen Connector und ruft die für die Connector-Manifestdatei erforderlichen IDs ab. Führen Sie diese API vor zum Verpacken der Connector-JAR-Datei.

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

Anforderungsheader

Anforderungstext

Der Text der Anfrage muss enthalten:

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

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

Antwort

Der Hauptteil 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. 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"
}

Auflisten registrierter Konnektoren

Listet alle benutzerdefinierten Konnektoren auf (die entweder 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

Anforderungsheader

Antwort

Der Hauptteil der Antwort enthält eine JSON-Zeichenfolge mit einer Liste registrierter Konnektoren. Dieses Beispiel zeigt eine Organisation mit dem registrierten Beispiel-Dropbox-Konnektor:

{
    "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 Connectorregistrierung

Löscht die Registrierung eines benutzerdefinierten Connectors. Diese API ist nur dann erfolgreich, wenn der Connector in keinem Projekte in der Organisation. Um die JSON- Payload zu löschen (die JSON-Datei, die die Benutzeroberfläche beschreibt, die im Manifest angegeben ist Eintrag Jitterbit-Connector-UI) eines benutzerdefinierten Connectors verwenden Sie die API, um eine Connector-Payload 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

Anforderungsheader

Löschen einer Connector-Payload

Löscht die JSON- Payload (die JSON-Datei, die die Benutzeroberfläche beschreibt, angegeben im Manifesteintrag Jitterbit-Connector-UI) von ein benutzerdefinierter Connector. Die Payload wird bei Harmony zwischengespeichert, um die Integration Studio Benutzeroberfläche des Connector. Diese API ist nur dann erfolgreich, wenn der Connector in keinem Projekt der Organisation verwendet wird. Zum Löschen die Registrierung eines benutzerdefinierten Connectors, verwenden Sie die API, um eine Connector-Registrierung löschen.

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

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

Anforderungsheader

Überprüfen eines Connectorschlüssels und -geheimnisses

Validiert ein Verbindungsschlüssel- und Geheimpaar.

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

wobei

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

Anforderungsheader

Anforderungstext

Der Text der Anfrage muss enthalten:

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

wobei

  • {connectorName}: Der Name des Konnektors
  • {key}: Der mit dem Anschluss dieses Namens verknüpfte Schlüssel
  • {secret}: Das mit dem Konnektor dieses Namens verknüpfte Geheimnis