This article assumes previous experience with APIs.
Az API-kulcs beállításának módjáról a Táblázatok, Operátorok és Gépek című cikkekben olvashat.
Használja a Tulip csatlakozókat a Tulip API teszteléséhez
Prior to r383, Service Accounts were called "API Tokens".
Olvassa el, hogyan kell konfigurálni egy csatlakozót, és állítsa be a csatlakozót a korábban beállított API-szolgáltatási fiók segítségével (a szolgáltatási fiók beállításáról ebben a cikkben olvashat).
Miután beállította a csatlakozót, kattintson a „Funkció létrehozása” gombra. Ebben a példában bemutatjuk, hogyan lehet rekordokat lekérni egy táblából.
Először létre kell hoznia egy GET, POST, PUT, HEAD, PATCH vagy DELETE kéréssel rendelkező kéréset, majd meg kell adnia azt a konkrét URL-címet, amelyre a kérést szeretné elküldeni (további információkat az API-képességeinkről itt talál) .
If you are using a global Service Account, you need to specify the workspace. If your Service Account is workspaced scoped, it is optional.
https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/tables/(TableID)/records
Ne felejtsd el hozzáadni a hitelesítést (maga a szolgáltatási fiókból), a kérésfejléceket (ha szükséges) és a lekérdezési paramétereket (akár magában az URL-ben, akár a lekérdezési paraméterekben – további információkért olvasd el , hogyan állítsd be a lekérdezési paramétereket).
Ezen felül megadhat bármilyen bemeneti vagy kimeneti adatot, amelyre a csatlakozó funkciónak szüksége lehet az alkalmazásba vagy az automatizálásba történő visszacsatoláshoz.
A Postman használata a Tulip API teszteléséhez
Az alábbiakban bemutatjuk, hogyan lehet létrehozni egy operátort. Ebben az esetben a példában a Postman segítségével hajtjuk végre a létrehozást.
Először adja hozzá az API végpontját a POST-kéréshez.
Ezután az Authorization (Hitelesítés) alatt válassza ki a Basic Auth (Alapvető hitelesítés) lehetőséget, és írja be az API-kulcsot felhasználónévként, az API-titkot pedig jelszóként.
A „Headers” (Fejlécek) alatt adja hozzá az „Auth Header” (Hitelesítési fejléc) elemet.
A Body mezőben formázza a kérést úgy, hogy befogadja a JSON-objektumot. A kérés általános formátuma a következő.
{"role": "operator","name": "string","badge_id": "string"}
Ez körülbelül így fog kinézni:
Kattintson a „Küldés” gombra a kérés futtatásához, és a sikerességet jelző 201-es válaszüzenetet kap. Ellenőrzésképpen megnézheti a „Beállítások” menüpontban található „Felhasználók” listáját, és meggyőződhet arról, hogy a felhasználó létrehozása sikeresen megtörtént.
Ha a kérés sikertelen volt, ellenőrizze, hogy a kulcs és a titkos kulcs helyes-e. További információk az egyes válasz kódokról a Tulip API oldal API dokumentáció szakaszában találhatók.
A Tulip API tesztelése az API-dokumentáció segítségével
A munkaterület vagy a fiók beállításaiban keresse meg a „Tulip API” menüpontot. Onnan kattintson a „További információk” gombra a „Szolgáltatási fiók létrehozása” opció mellett.
Ezzel egy olyan oldalra jut, ahol a létrehozott kulccsal tesztelheti az API-t. Az oldal dokumentációt és példákat is tartalmaz a különböző felhasználási célokra szolgáló kérelemtestekről.
Ezen az oldalon található az a szerver-URL is, amely a külső rendszerekből érkező API-lekérdezések konfigurálásához szükséges. Az API megismeréséhez kattintson az „Engedélyezés” gombra.
Ez a gomb további információkat nyújt 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ó: Titkos kulcs
Kattintson az „Authorize” gombra, és elkezdheti tesztelni a táblákra vonatkozó néhány általános HTTP-kérést.
Az ezen az oldalon található összes opció kibontható és tesztelhető. Minden kérés hasznos információkat nyújt a hozzá tartozó válaszokról.
Ezen az oldalon a Tulip egyes komponenseinek sémáira vonatkozó információk is megtalálhatók. Például egy táblázati rekord létrehozásához hasznos tudni az egyes oszlopok megfelelő JSON-formátumát. Az oszlopokra vonatkozó példaséma az alábbiak szerint:
