Erstellen Sie eine einfache benutzerdefinierte API im Jitterbit API-Manager
Einführung
Diese Seite richtet sich an neue Benutzer von API-Manager und zeigt, wie Sie mithilfe eines Integration Studio eine benutzerdefinierte API manuell erstellen und veröffentlichen Operation.
Informationen zum Erstellen und Veröffentlichen einer API durch die Teilnahme an einem interaktiven schriftlichen Dialog mit einem KI-Chatbot finden Sie unter Jitterbit AI Bot (Beta) für Jitterbit API-Manager.
Für eine umfassende Anleitung und eine Schritt-für-Schritt-Anleitung melden Sie sich für API -Erstellung und-Verwaltung an Kurs auf Jitterbit University.
Informationen zur Konfiguration eines bestimmten API Typs finden Sie in diesen Ressourcen:
Voraussetzungen
Bevor Sie eine benutzerdefinierte 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 in Harmony-Berechtigungen und-Zugriff beschrieben.
Erstellen einer API mit API-Manager
Befolgen Sie diese Schritte, um mit API-Manager eine benutzerdefinierte 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, ein Integration Studio oder Design Studio Operation muss zuerst erstellt und in derselben Umfeld bereitgestellt werden, in der Sie eine benutzerdefinierte API erstellen möchten.
In diesem Integration Studio Beispiel fragt der bereitgestellte Operation eine Datenbank ab und verarbeitet die Daten in eine 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 der Integration Studio oder Design Studio Operation bereitgestellt wurde, navigieren Sie zur APIs Seite im API-Manager und klicken Sie auf Neu > Custom API:
Wenn Sie auf Custom API klicken, wird der Konfigurationsbildschirm für die API -Einstellungen geöffnet. Füllen Sie jedes Feld mit den folgenden 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 benutzerdefinierte API erstellt wird, wurde Custom API als Diensttyp ausgewählt. Der Integration Studio Operation aus Schritt 1: Operation erstellen und einsetzen ist 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: Erstellen und einsetzen der Operation). Daher 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 Benutzerverwaltungsseite 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 aktiv ist:
Klicken Sie auf URL kopieren. Die kopierte URL wird in [Schritt 3: API testen] verwendet.#buildingasimplecustomapi-step-3).
Schritt 3: Testen der API
Um die API zu testen, fügen Sie die API URL aus Schritt 2: Konfigurieren der API ein in 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 aktiv ist, können Sie API verwalten, indem Sie eine API -Dokumentation im Portal Manager erstellen Seite, Anzeigen der Protokolle auf der API Protokolle oder überprüfen Sie die Verbrauchs- und Leistungsmetriken für die API auf der Analytics Seite.
Weitere Informationen zum API-Manager finden Sie in den folgenden Ressourcen: