Aktivieren einer API ausgehend von einem Datensatz

Ausgehend von der Übersicht eines kompatiblen Datensatzes können Sie problemlos eine API aktivieren, die dann den Zugriff auf die enthaltenen Daten ermöglicht.

Vorbereitungen

Wenn Sie eine Remote Engine Gen2 einsetzen, haben Sie die Engine über den folgenden Befehl gestartet, um ein kompatibles Engine-Profil zu verwenden: sudo ./remote-engine.sh start -r <region> -k <pair key> -p data-apis, wobei der Wert für Ihre Region us (USA), eu (EU), ap (Asien-Pazifik) oder au (Australien) sein kann.
Ihnen wurde in Talend Management Console die Rolle Dataset administrator (Datensatzadministrator) oder Dataset manager (Datensatzmanager) oder zumindest die Berechtigungen View API (API anzeigen) und Manage API (API verwalten) zugewiesen.

Prozedur

Wählen Sie in der Datensatzliste den Datensatz aus, der über die API zur Verfügung gestellt werden soll.
Für die Konfiguration der API ausgehend von der Übersicht des Datensatzes stehen Ihnen folgende Möglichkeiten zur Auswahl:
- Klicken Sie auf die Registerkarte API im linken Menü.
- Klicken Sie auf Enable (Aktivieren) in der Kachel API.
Klicken Sie auf Get started (Erste Schritte), um das Formular zur API-Konfiguration aufzurufen.
Geben Sie in das Feld Entity set name (Name der Entitätsgruppe) einen Namen ein, der dann den definitiven API-URL bildet.
Wählen Sie in der Dropdown-Liste Primary key (Primärschlüssel) das Feld aus, das zur Auswahl spezifischer Datenelemente im Quelldatensatz verwendet werden soll.
Standardmäßig wird das erste Feld im Datensatz ausgewählt.
Klicken Sie auf Add (Hinzufügen), um die Consumer festzulegen, die zum Aufruf der API berechtigt sein sollen.
Geben Sie in das Feld Name den Namen des Consumers ein.
Wählen Sie eine Methode für die Authentication (Authentifizierung) in der Dropdown-Liste Type (Typ) aus.
- Legen Sie für die Basis-Authentifizierung (Basic) die Anmeldedaten fest, die der Consumer dann in die Felder Username (Benutzername) und Password (Passwort) eingeben muss.
- Für die Authentifizierung des Typs Api key (API-Key) klicken Sie auf Generate API key (API-Key generieren) und kopieren das generierte Token zur Verwendung in Ihrem Request-Header.
Klicken Sie auf Add (Hinzufügen).
Der Consumer wird dann in der Liste angezeigt, und Sie können nach Wunsch weitere Consumer hinzufügen.
Um die API-Konfiguration abzuschließen und die automatisch generierte API zu starten, klicken Sie auf Enable (Aktivieren).

Ergebnisse

Sie kehren zur Ansicht API des Datensatzes zurück, die dieses Mal zwei Kacheln umfasst:

Die Kachel Consuming (Konsumieren) mit der URL der API zur gemeinsamen Nutzung mit den Consumern, je nachdem, ob Sie http oder https verwenden, Beispiele für Requests mit größerer Expressivität, die einfach wiederverwendet werden können, sowie eine Download-Schaltfläche, über die eine OAS3-Definition der API abgerufen werden kann. Über die Schaltfläche Open in API Tester (In API Tester öffnen) können Sie einen vorkonfigurierten API-Aufruf in Talend API Tester testen.
Die Kachel Monitoring (Überwachen), in der Sie die Aktivität der API in den letzten 24 Stunden überwachen und feststellen können, ob die Aufrufe erfolgreich waren oder nicht.

Über den Schalter Enable API (API aktivieren) können Sie die API je nach Situation schnell deaktivieren bzw. aktivieren. Oder Sie klicken auf Edit (Bearbeiten), wenn Sie zum Konfigurationsformular zurückkehren möchten.

In der Kachel API der Datensatzübersicht finden Sie benfalls eine Übersicht über den API-Status und die API-Aktivität.

Wichtig: In folgenden Fällen verhindert ein bekanntes Problem Umständen die Aktivierung einer API für einen für Sie freigegebenen Datensatz:

Der Datensatz wurde für Benutzergruppen freigegeben. Versuchen Sie in diesem Fall, den Datensatz für andere Benutzer einzeln freizugeben.
Die Person, die zuletzt Änderungen am Datensatz vorgenommen hat, oder die zugehörige Verbindung hat ihre Rechte in Bezug auf den Datensatz verloren. Versuchen Sie in diesem Fall, den Datensatz erneut für diese Person bzw. diese Verbindung freizugeben, oder wenden Sie sich an Ihren Talend-Supportkontakt mit der Bitte, den Datensatz zu aktualisieren.

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!

Geben Sie hier Ihr Feedback ab