So verwenden Sie die Tabellen-API
  • 16 Oct 2023
  • 4 Minuten zu lesen
  • Mitwirkende

So verwenden Sie die Tabellen-API


Article Summary

Zweck

Einrichten und Verwenden der Tulip API, um mit Tulip von anderen Systemen aus zu interagieren.

Anmerkung: Fortgeschrittener Artikel.

Setzt vorherige Erfahrung mit APIs voraus.

:::(Info) (HINWEIS) Fortgeschrittener Artikel: Setzt frühere Erfahrung mit APIs voraus :::

Tulip interagiert mit vielen APIs anderer Systeme über Konnektoren. Konnektoren verwenden Eine Tulip-Anwendung kann eine HTTP- oder SQL-Abfrage initiieren.

In anderen Fällen möchten Sie vielleicht einem externen System erlauben, Daten abzufragen, die nur in Tulip vorhanden sind. Es ist möglich, mit Tulip von externen Systemen aus über die Tulip API zu kommunizieren. Dieser Artikel führt Sie durch die Einrichtung und das Testen der Tulip-API.

Die Tulip-API ist für die Integration dieser externen Systeme mit Tulip in vielerlei Hinsicht nützlich. Die API funktioniert derzeit nur mit Tulip-Tabellen. Das kann das Aktualisieren eines Tabellendatensatzes mit neuen Informationen, das Erstellen einer Tabelle oder das Abrufen der Anzahl der Datensätze in einer Tabelle sein.

Hinzufügen einer API

Navigieren Sie zur Seite Einstellungen Ihres Tulip-Kontos.

Im Menü Einstellungen wählen Sie API Token.

Auf dieser Seite können Sie "API Token" konfigurieren, d.h. API-Konfigurationen, die mit einem API-Schlüssel, einem Geheimnis und einem Autorisierungs-Header ausgestattet sind. Um ein API-Token hinzuzufügen, wählen Sie die Schaltfläche "Add API Token" oben rechts auf dieser Seite. Konfigurieren Sie dann das API-Token wie gewünscht.

Geben Sie dem API-Token einen Namen, und legen Sie die Bereiche fest, die es ausführen darf. In diesem Beispiel kann das API-Token von Tulip-Tabellen lesen und auch in sie schreiben. API-Tokens können archiviert werden, wenn sie nicht verwendet werden.

Wenn Sie auf Erstellen klicken, werden die API-Informationen angegeben. Achten Sie darauf, diese Informationen zu speichern, da sie nicht wieder abgerufen werden können!

Diese Informationen können nun verwendet werden, um eine Verbindung zur Tulip API zu konfigurieren.

Testen der API

Schließen Sie das Info-Popup und navigieren Sie zur Schaltfläche API-Dokumentation, neben der Option API-Token erstellen.

Dies führt Sie zu einer Seite, die das Testen der API mit dem erstellten Schlüssel ermöglicht. Sie bietet auch eine Dokumentation und Beispiele für Anforderungskörper für verschiedene Zwecke.

Auf dieser Seite finden Sie auch die Server-URL, die Sie benötigen, um API-Anfragen von externen Systemen zu konfigurieren. Um sich mit der API vertraut zu machen, klicken Sie auf die Schaltfläche Autorisieren.

Über diese Schaltfläche erhalten Sie weitere Informationen über die Konfiguration der API zu Testzwecken. Geben Sie in die Felder Folgendes ein:

  • Benutzername: API-Schlüssel
  • Passwort: Geheimnis

Klicken Sie auf authorize, und Sie können mit dem Testen einiger gängiger HTTP-Anfragen für Tabellen beginnen.

Jede der Optionen auf dieser Seite kann erweitert und getestet werden. Jede Anfrage bietet nützliche Informationen zu den entsprechenden Antworten.

Auf dieser Seite finden Sie auch Informationen über Schemas für einige Komponenten von Tulip. Um zum Beispiel einen Tabellendatensatz zu erstellen, ist es nützlich, die entsprechende JSON-Formatierung für jede Spalte zu kennen. Ein Beispiel für ein Schema für Spalten wird unten gezeigt:

Abfragen mit Filtern

Filter können sehr nützlich sein, um nur die Daten zu extrahieren, an denen Sie interessiert sind. Diese Filter können in ihrer Syntax manchmal etwas kompliziert sein. Im Folgenden wird erläutert, wie jeder Filter im Beispiel einer GET-Anfrage für Datensätze gebildet wird, gefolgt von einem vollständigen Beispiel.

DenFeldnamen für benutzerdefinierte Felder wird immer eine fünfstellige Kennung vorangestellt. Diese können am einfachsten nach einer GET-All-Anfrage gefunden werden, um den wahren Namen des Feldes zu überprüfen.

  • Beispiel. "Feld"="maytq_scrap_count"

Argumentwerte sind oft einfach zu verstehen. Wenn es sich um einen Textwert handelt, müssen Sie ihn in Anführungszeichen setzen.

  • Beispiel. "arg":15

Passen Sie den Funktionstyp an, den Sie verwenden möchten.

  • Bsp. "functionType": "greaterThan"

Eine vollständige Anfrage hierfür könnte etwa so aussehen:

https://brian.tulip.co/api/v3/tables/W2HPvyCZrjMMHTiip/records?limit=100&sortBy=\_sequenceNumber&sortDir=asc&filters=[{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"}]&filterAggregator=any

Mehrere Filter

In manchen Fällen müssen Sie mehrere Filter in der Tabelle überprüfen. In diesem Fall können Sie dem Filterobjekt mehrere Filter hinzufügen. Dies könnte etwa so aussehen:

filters=[{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"},{"field": "maytq\_scrap\_reason", "arg": "scratch", "functionType": "equal"}]

Beispiele

Die folgenden Beispiele führen Sie durch den Prozess der Anfragen an die Tulip-API. In diesen Beispielen wird Postman verwendet, um die Anfragen von Tulip zu stellen.

Tabellennamen und Informationen abfragen

Diese Abfrage ermöglicht es dem externen System, die IDs und Spalteninformationen aller Tabellen innerhalb der Tulip-Instanz abzurufen. Dies kann nützlich sein, um eine Tabelle von Interesse zu finden, um eine POST-Anfrage einzurichten.

Setzen Sie in Postman die Autorisierung auf Basic Auth und geben Sie den API Key und Secret ein.

Nun muss die Anfrage an die richtige Stelle weitergeleitet werden. Suchen Sie in Tulip die gewünschte Anfrage in der API-Dokumentation. In diesem Fall ist die Anfrage, alle Tabelleninformationen zu erhalten.

Um die Anfrage-URL zu erhalten, klicken Sie auf die Schaltfläche Ausführen und suchen Sie nach den Anfragedaten.

Diese Anfrage-URL kann dann als Server-URL verwendet werden, um die GET-Anfrage von Postman zu verarbeiten.

Klicken Sie auf Senden, und die Anfrage wird alle Informationen aus den Tabellen zurückgeben.

Erstellen Sie einen Tabellensatz

Mit einem POST und der oben gefundenen Tabellen-ID kann ein Tabellendatensatz aus dem externen System erstellt werden. Die Autorisierung und der Header bleiben gleich, aber die Anfrage-URL wird etwas anders sein.

Bestimmen Sie zunächst die Tabelle, in der Sie einen Datensatz erstellen möchten. Die Anfrage-URL folgt immer der folgenden Struktur:

https://.tulip.co/api/v3/tables//records

Nach der Eingabe benötigt die Anfrage auch einen Body, um die POST korrekt zu verarbeiten. Das Spaltenschema ist oben im Abschnitt Tests angegeben und kann in der API-Dokumentation nachgelesen werden. Die einzige Spalte, die für den Erfolg der Anfrage unbedingt erforderlich ist, ist die Spalte ID. Alle anderen Spalten, die nicht hinzugefügt werden, werden bei der Erstellung als Null im Tabellendatensatz gespeichert. Fügen Sie diesen Inhalt als Body für die Anfrage hinzu.

Bei der Übermittlung prüft Postman, ob der Datensatz erstellt worden ist.


Haben Sie gefunden, wonach Sie gesucht haben?

Sie können auch auf community.tulip.co Ihre Frage stellen oder sehen, ob andere mit einer ähnlichen Frage konfrontiert wurden!


War dieser Artikel hilfreich?