Erstellen Sie eine einfache Custom API im Jitterbit API-Manager
Einführung
Diese Seite richtet sich an neue Benutzer von API-Manager und zeigt, wie Sie eine Custom API mithilfe eines Integration Studio Operation.
Für eine umfassende Anleitung und eine Schritt-für-Schritt-Anleitung registrieren Sie sich für API Erstellung und-Verwaltung Kurs an der Jitterbit University.
Informationen zur Konfiguration eines bestimmten API Typs finden Sie in diesen Ressourcen:
Voraussetzungen
Bevor Sie eine Custom API erstellen, müssen Sie Mitglied einer Harmony-Organisation mit einem Abonnement für API-Manager sein und über die entsprechenden Organisationsberechtigungen und Umfeld verfügen, wie unter Harmony Berechtigungen und-Zugriff beschrieben.
Erstellen einer API mit API-Manager
Befolgen Sie diese Schritte, um mit API-Manager eine Custom API zu erstellen:
- Schritt 1: Operation erstellen und einsetzen
- Schritt 2: Konfigurieren Sie die API
- Schritt 3: Testen Sie die API
Schritt 1: Erstellen und einsetzen der Operation
Wie in den Voraussetzungen für Custom API beschrieben, A Integration Studio oder Design Studio Operation muss zuerst erstellt und in derselben Umfeld bereitgestellt werden, in der Sie eine Custom API erstellen möchten.
In diesem Integration Studio Beispielsweise fragt der bereitgestellte Operation eine Datenbank ab und verarbeitet die Daten in einer CSV-Ausgabe:
Anweisungen zum Erstellen und Bereitstellen einer Operation in Integration Studio oder Design Studio, siehe diese Ressourcen:
- Integration Studio
- Design Studio
Schritt 2: Konfigurieren der API
Sobald die Integration Studio oder der Design Studio Operation wurde bereitgestellt. Navigieren Sie zur Seite „Meine APIs“ im API-Manager und klicken Sie auf Neue API:
Wenn Sie auf Neue API klicken, wird der Konfigurationsbildschirm für die API -Einstellungen geöffnet. Füllen Sie jedes Feld mit diesen Einstellungen aus:
Sobald die obigen Felder ausgefüllt sind, klicken Sie auf Weiter.
Hinweis
Informationen zu den einzelnen Feldern in diesem Konfigurationsbildschirm finden Sie unter Schritt 1: Einstellungen auf Custom API Konfiguration.
Da eine Custom API erstellt wird, wurde Custom API als Diensttyp ausgewählt. Die Integration Studio Operation aus Schritt 1: Operation erstellen und einsetzen wird dem GET API Dienst zugewiesen:
Nachdem die obigen Felder ausgefüllt und der Operation zugewiesen wurde, klicken Sie auf Speichern und dann auf Weiter.
Notiz
Die für die Zwecke dieses Handbuchs verwendete Operation verfügt über eine API Antwortaktivität als Ziel der Operation konfiguriert (siehe Schritt 1: Operation erstellen und einsetzen). Als Ergebnis wird der Antworttyp auf Endziel gesetzt.
Weitere Informationen zu den Feldern Projekte, Operation, Methode und Antworttyp finden Sie unter Schritt 2: Servicetyp auswählen und Operationen zuweisen auf Custom API Konfiguration.
Auf dem nächsten Bildschirm werden der benutzerdefinierten API Benutzerrollen und ein oder mehrere entsprechende Sicherheitsprofile zugewiesen:
Zur Auswahl stehen die Rollen, die auf der Tab „Rollen“ der Seite „Benutzerverwaltung“ definiert sind.
Weitere Informationen zum Zuweisen von Benutzerrollen finden Sie unter Schritt 3: Benutzerrollen und Sicherheitsprofile zuweisen auf Custom API Konfiguration.
Weitere Informationen zu Sicherheitsprofilen finden Sie in diesen Ressourcen:
Wenn Sie auf Weiter klicken, gelangen Sie zur Seite Zusammenfassung und Bestätigung:
Wenn Sie auf Speichern und Veröffentlichen klicken, wird in einem Dialogfeld angezeigt, dass die API live ist:
Klicken Sie auf URL kopieren. Die kopierte URL wird in Schritt 3: Testen der API verwendet.
Schritt 3: Testen der API
Um die API zu testen, fügen Sie die API URL aus Schritt 2: Konfigurieren der API einen Webbrowser ein:
Nach der Authentifizierung wird der Integration Studio Operation aus Schritt 1: Operation erstellen und einsetzen wird ausgelöst und antwortet mit einer CSV-Ausgabe der Kundenliste des Beispielunternehmens:
Nächste Schritte
Sobald die API live ist, können Sie die API verwalten, indem Sie eine API Dokumentation im Portal Manager generieren Seite, Anzeigen der Protokolle auf der API Protokolle oder überprüfen Sie die Verbrauchs- und Leistungsmetriken für die API auf der Seite Analytics Seite.
Weitere Informationen zum API-Manager finden Sie in den folgenden Ressourcen: