A táblázat API használata

Cél

A Tulip API beállítása és használata a Tulippal való interakcióhoz más rendszerekből.

Megjegyzés: Speciális cikk.

Feltételezi az API-kkal kapcsolatos korábbi tapasztalatokat.

:::(Info) (MEGJEGYZÉS) Haladó cikk: Feltételezi az API-kkal kapcsolatos korábbi tapasztalatokat :::

A Tulip számos más rendszer API-jával lép kölcsönhatásba a csatlakozókon keresztül. A csatlakozók használata Egy Tulip alkalmazás HTTP vagy SQL lekérdezést kezdeményezhet.

Más esetekben lehet, hogy egy külső rendszernek szeretné lehetővé tenni, hogy lekérdezzen olyan adatokat, amelyek csak a Tulipban léteznek. A Tulip API segítségével külső rendszerekből is lehet kommunikálni a Tulippal. Ez a cikk a Tulip API beállítását és tesztelését mutatja be.

A Tulip API többféleképpen is hasznos e külső rendszerek Tulipba való integrálásához. Az API jelenleg csak a Tulip táblákkal működik Ez lehet egy táblázat rekordjának frissítése új információval, egy táblázat létrehozása vagy a táblázatban lévő rekordok számának lekérdezése.

API hozzáadása

Navigáljon a Tulip fiókjának Beállítások oldalára.

A Beállítások menüben válassza az API tokeneket.

Ez az oldal lehetővé teszi az "API tokenek" konfigurálását, amelyek API-kulccsal, titokkal és engedélyezési fejléccel ellátott API-konfigurációk. API Token hozzáadásához válassza az oldal jobb felső sarkában található Add API Token gombot. Ha kiválasztotta, konfigurálja az API Tokent a kívánt módon.

Adjon nevet az API Tokennek, és határozza meg a számára engedélyezett hatóköröket. Ebben a példában az API-token képes olvasni a Tulip táblákból, és írni is tud rájuk. Az API tokenek archiválhatók, ha nem használják őket.

A Létrehozás gombra kattintva az API információi kerülnek megadásra. Győződjön meg róla, hogy elmenti ezeket az információkat, nem lehet újra hozzáférni!

Ezekkel az információkkal most már konfigurálható a Tulip API-hoz való kapcsolat.

Az API tesztelése

Zárja be az információs felugró ablakot, és navigáljon át az API dokumentáció gombra, az API token létrehozása opció mellett.

Ez egy olyan oldalra vezet, amely lehetővé teszi az API tesztelését az elkészített kulccsal. Dokumentációt is biztosít, és példákat ad a különböző felhasználási célokra szolgáló kéréstestekre.

Ez az oldal tartalmazza a külső rendszerekből érkező API-kérések beállításához szükséges kiszolgáló URL-címet is. Az API megismeréséhez kattintson az Engedélyezés gombra.

Ez a gomb további információkat ad az API tesztelési célú konfigurálásáról. A mezőkbe írja be a következőket:

• Felhasználónév: API-kulcs
• Jelszó: Titok

Kattintson az engedélyezésre, és máris elkezdheti tesztelni a Táblák néhány gyakori HTTP-kérését.

Ezen az oldalon minden egyes lehetőség kibővíthető és tesztelhető. Minden egyes kérés hasznos információkat nyújt a megfelelő válaszokról.

Ezen az oldalon belül a Tulip egyes összetevőinek sémáiról is talál információkat. Például egy táblázat rekordjának létrehozásához hasznos ismerni az egyes oszlopok megfelelő JSON-formázását. Példa az oszlopok sémájára az alábbiakban látható:

Szűrőkkel történő lekérdezés

A szűrők nagyon hasznosak lehetnek ahhoz, hogy csak az Önt érdeklő adatokat vonja ki. Ezek a szűrők néha kicsit trükkösek lehetnek a szintaxisukkal. Az alábbiakban a rekordok GET-kérelmének példáján, majd egy teljes példán keresztül ismertetjük, hogy az egyes szűrők hogyan alakulnak.

Az egyénimezők mezőnevei elé mindig egy ötjegyű karakterlánc-azonosító kerül. Ezeket a legkönnyebben egy GET all kérés után lehet megtalálni, hogy ellenőrizni lehessen a mező valódi nevét.

• Pl. "mező"="maytq_scrap_count"

Az argumentumértékek gyakran egyszerűek. Ha szöveges értékről van szó, mindenképpen tegye idézőjelbe.

• Pl. "arg":15

Egyeztesse a használni kívánt függvénytípussal.

• Pl. "functionType": "greaterThan"

Egy teljes kérés erre a célra valahogy így nézhet ki:

{"field": "maytq\_scrap\_count", "arg":15, "functionType": "greaterThan"}]&filterAggregator=any

Több szűrő

Bizonyos esetekben előfordulhat, hogy a táblázatban több szűrőt is ellenőrizni kell. Ebben az esetben többszöröseket adhat a filter objektumhoz. Ez valahogy így nézhet ki:

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

Példák

A következő példák végigvezetik a Tulip API-hoz intézett kérések folyamatát. Ezek a példák a Postman-t fogják használni a Tulip kérésekhez.

Táblák nevének és információinak lekérdezése

Ez a Get kérés lehetővé teszi a külső rendszer számára, hogy lekérje a Tulip példányban lévő összes táblázat azonosítóit és oszlopinformációit. Ez hasznos módszer lehet egy érdekes Táblázat keresésére egy POST-kérés beállításához.

A Postmanben állítsa az Engedélyezést Basic Auth értékre, és adja meg az API-kulcsot és a titkot.

Most a kérésnek a megfelelő helyre kell mennie. A Tulipban keresse meg az API dokumentációból a kérést, amit szeretne elkészíteni. Ebben az esetben a kérés az összes Tábla-információ lekérdezése.

A kérés URL címének megszerzéséhez futtassa az Execute gombot, és keresse meg a Request Information (Kérés információi) elemet.

Ezt a Request URL-t ezután a Server URL-ként használhatja a Postman által küldött GET-kérés feldolgozásához.

Nyomja meg a Send gombot, és a kérés visszaküldi a táblázatok összes információját.

Táblázati rekord létrehozása

Egy POST és a fenti táblázat azonosító segítségével létrehozható egy táblázatrekord a külső rendszerből. Az engedélyezés és a fejléc ugyanaz marad, de a kérési URL egy kicsit más lesz.

Először határozza meg a Táblát, amelyben rekordot szeretne létrehozni. A kérési URL mindig a következő struktúrát követi:

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

A bevitelt követően a kérésnek szüksége lesz egy testre is, hogy a POST-ot megfelelően feldolgozhassa. Az oszlopok sémáját fentebb a Tesztelés szakaszban adtuk meg, és megtalálható az API dokumentációban. Az egyetlen oszlop, amely teljes mértékben szükséges a sikerhez, az ID oszlop. Minden más oszlop, amely nem kerül hozzáadásra, a létrehozáskor nullaként kerül tárolásra a táblázat rekordjában. Adja hozzá ezt a tartalmat a kérelem testeként.

A beküldéskor a Postman ellenőrzi a rekord létrehozását.

Megtalálta, amit keresett?

A community.tulip.co oldalon is megteheti, hogy felteszi kérdését, vagy megnézheti, hogy mások is szembesültek-e hasonló kérdéssel!