Erstellen Sie eine einfache benutzerdefinierte API im Jitterbit API Manager

Einführung

Diese Seite richtet sich an neue Benutzer des API Managers und zeigt, wie man manuell eine benutzerdefinierte API erstellt und veröffentlicht, indem man eine Studio Operation verwendet.

Für einen umfassenden Leitfaden und eine schrittweise Anleitung melden Sie sich für den Kurs API-Erstellung und -Verwaltung an der Jitterbit University an.

Für Informationen zur Konfiguration eines bestimmten API-Typs siehe diese Ressourcen:

• Benutzerdefinierte APIs
• OData APIs
• Proxy APIs

Voraussetzungen

Bevor Sie eine benutzerdefinierte API erstellen, müssen Sie Mitglied einer Harmony-Organisation mit einem Abonnement für den API Manager sein und die entsprechenden Organisationsberechtigungen sowie Zugriffslevel auf die Umgebung haben, wie in Harmony-Berechtigungen und -Zugriff beschrieben.

Erstellen Sie eine API mit dem API Manager

Befolgen Sie diese Schritte, um eine benutzerdefinierte API mit dem API Manager zu erstellen:

• Schritt 1: Erstellen und Bereitstellen der Operation
• Schritt 2: Konfigurieren der API
• Schritt 3: Testen der API

Schritt 1: Erstellen und Bereitstellen der Operation

Wie in den Voraussetzungen für benutzerdefinierte APIs beschrieben, muss zunächst eine Studio oder Design Studio Operation erstellt und in derselben Umgebung bereitgestellt werden, in der Sie eine benutzerdefinierte API erstellen möchten.

In diesem Studio-Beispiel fragt die bereitgestellte Operation eine Datenbank ab und verarbeitet die Daten in eine CSV-Ausgabe:

Für Anweisungen zur Erstellung und Bereitstellung einer Operation in Studio oder Design Studio siehe diese Ressourcen:

• Studio
  • Schnellstartanleitung für Studio
  • Erstellung und Konfiguration von Operationen
  • Bereitstellung und Ausführung von Operationen
• Design Studio
  • Erstellen einer Operation

Schritt 2: Konfigurieren Sie die API

Sobald die Operation im Studio oder Design Studio bereitgestellt wurde, navigieren Sie zur API-Seite im API-Manager und klicken Sie auf Neu > Benutzerdefinierte API:

Wenn Sie auf Benutzerdefinierte API klicken, öffnet sich der Bildschirm zur API-Konfiguration.

Grundlegende Einstellungen konfigurieren

Geben Sie die grundlegenden Informationen für Ihre API ein:

Füllen Sie die erforderlichen Felder wie API-Name, Umgebung und Service-Root aus. Sie können auch eine optionale Beschreibung und Versionsnummer hinzufügen.

Operationen zuweisen

Weisen Sie die Operation aus Schritt 1 der API zu. In diesem Beispiel wird die Operation der GET-Methode zugewiesen:

Konfigurieren Sie die folgenden Einstellungen:

• Service Name: Geben Sie einen beschreibenden Namen für diesen Dienst ein.
• Method: Wählen Sie GET.
• Path: Lassen Sie dieses Feld leer.
• Project: Wählen Sie das Projekt aus, das Ihre Operation enthält.
• Operation To Trigger: Wählen Sie die Operation aus, die Sie in Schritt 1 erstellt haben.
• Response Type: Stellen Sie auf Final Target ein (die in diesem Leitfaden verwendete Operation hat eine API Response activity, die als Ziel konfiguriert ist).

Sicherheits- und Benutzerrollen zuweisen

Konfigurieren Sie, wer auf Ihre API zugreifen und sie nutzen kann:

Sicherheitsprofile definieren, wie API gateways Anfragen an Ihre API authentifizieren und autorisieren. Die Rollen, aus denen Sie wählen können, sind die, die auf der Rollen-Registerkarte der Benutzerverwaltungsseite definiert sind.

Für weitere Informationen zur Zuweisung von Benutzerrollen und Sicherheitsprofilen verweisen Sie auf die Registerkarten User roles und Security profiles in custom API configuration.

Für weitere Informationen zur API-Sicherheit siehe Key concepts.

Überprüfen und veröffentlichen

Wenn Sie bereit sind, die API live zu schalten, klicken Sie auf Publish. Ein Dialog zeigt an, dass die API live ist:

Klicken Sie auf Copy URL. Sie verwenden die kopierte URL in Schritt 3, um die API zu testen.

Schritt 3: Testen Sie die API

Um die API zu testen, fügen Sie die API-URL aus Schritt 2 in einen Webbrowser ein:

Sobald die Authentifizierung erfolgt ist, wird die Studio-Operation aus Schritt 1 ausgelöst und antwortet mit einer CSV-Ausgabe der Kundenliste von Example Company:

Nächste Schritte

Sobald die API aktiv ist, können Sie die API verwalten, indem Sie die API-Dokumentation auf der Portal Manager Seite generieren, die Protokolle auf der API Logs Seite einsehen oder die Verbrauchs- und Leistungskennzahlen der API auf der Analytics Seite überprüfen.