Erste Schritte mit der xTend-API

KB ARTICLE

Übersicht

Die FactoryLogix xTend-API ist eine REST-Schnittstelle, die es externen Systemen ermöglicht, programmgesteuert mit FactoryLogix zu interagieren. In diesem Artikel werden die Kommunikationskanäle, die URL-Struktur sowie das Herstellen einer Verbindung und das Ausführen von API-Aufrufen beschrieben.

Kommunikationskanäle

Die REST-Schnittstelle unterstützt zwei Kommunikationskanäle:

• Ersetzen Sie [myserver] durch den Namen des Servers, auf dem der FactoryLogix xTend API Service ausgeführt wird.

• Ersetzen Sie [ServiceName] durch den entsprechenden Dienst-Namespace und [Method] durch die konkret aufzurufende Methode.

Verfügbare Dienste

Die Dienste sind in Namensräumen organisiert, von denen jeder Methoden für eine bestimmte Kategorie von Vorgängen enthält.

• Um die in einem bestimmten Namensraum verfügbaren Methoden anzuzeigen, fügen Sie /help an eine URL an, die diesen Namensraum enthält.
  

Voraussetzungen

• Der FactoryLogix xTend API-Dienst läuft auf dem Zielserver.

• Es liegen gültige FactoryLogix-Anmeldedaten vor.

• Ein API-Client wie beispielsweise Postman ist installiert. Das Postman-Desktop-Installationsprogramm ist unter https://www.postman.com/downloads/ verfügbar.

Verbindung herstellen und eine Sitzungs-ID abrufen

Für alle API-Interaktionen ist eine aktive Sitzung erforderlich.

• Verwenden Sie die Methode Connect im Namespace ConnectionServices, um eine Sitzung herzustellen.

Beispiel für einen Connect-Endpunkt:

http://[myserver]:6063/FactoryLogix_xTendAPIService/json/ConnectionServices/Connect

Beispiel für einen JSON-Anfragetext:

{
  "serverName": "grichards",
  "userName": "aegisadmin",
  "password": "",
  "databaseConnection": "FactoryLogix"
}

Bei einer erfolgreichen Verbindung wird eine ConnectResult-Antwort zurückgegeben, die einen „sessionID“-Wert enthält. Notieren Sie sich diesen Wert; er ist für alle nachfolgenden API-Aufrufe erforderlich.

Behebung von Verbindungsfehlern

Wenn bei der Herstellung der Verbindung ein Fehler auftritt, überprüfen Sie Folgendes:

• Der xTend-API-Dienst läuft auf dem ausgewählten Server.

• Die eingegebenen Anmeldedaten sind korrekt.

• Alle Parameternamen im Request-Body sind korrekt geschrieben.

API-Aufruf durchführen

• Sobald die Verbindung hergestellt ist, verwenden Sie die von der Connect-Methode zurückgegebene sessionId im Body nachfolgender Anfragen. Das folgende Beispiel ruft die GetItem-Methode auf:

{
  "sessionId": "5b4b049d-478d-e30c-db68-08d8a25b8399",
  "itemUID": "tool1g"
}

Verbindung trennen

• Um eine Sitzung zu beenden, rufen Sie die Methode Disconnect auf:

http://[myserver]:6063/FactoryLogix_xTendAPIService/json/ConnectionServices/Disconnect

Beispiel für den Anfragetext:

{
  "sessionId": "5b4b049d-e6a9-9926-d624-08d8d41cfbf2"
}

Nützliche Methoden für Verbindungsdienste