Állítsa be és használja a Tulip API-t, hogy más rendszerekből is kommunikálhasson a Tulip-pal.
This article assumes previous experience with APIs.
A Tulip a csatlakozók (Connectors) segítségével kommunikál számos más rendszer API-jával. A csatlakozók használatával egy Tulip-alkalmazás HTTP- vagy SQL-lekérdezést indíthat el.
Más esetekben előfordulhat, hogy lehetővé szeretné tenni egy külső rendszer számára, hogy olyan adatokat lekérdezzen, amelyek kizárólag a Tulip-on belül léteznek. A Tulip API segítségével külső rendszerekből is kommunikálni lehet a Tulip-pal. Ez a cikk végigvezeti a Tulip API beállításának és tesztelésének lépésein.
A Tulip API számos módon hasznos lehet ezeknek a külső rendszereknek a Tulipba történő integrálásához. Az API jelenleg csak a Tulip táblákkal működik. Ez magában foglalhatja egy táblarekord frissítését új információkkal, egy táblázat létrehozását vagy a táblában található rekordok számának lekérdezését.
A Stations API funkciói
A Stations API segítségével gyorsan kezelheti és regisztrálhatja az új állomásokat. Általános funkciója az állomások, állomáscsoportok és interfészek (korábban kijelzőeszközök néven ismert) létrehozása, felsorolása és módosítása. További információk itt találhatók.
Például írhat egy szkriptet, amely lehetővé teszi, hogy minden új felhasználó beállítása alkalmával automatikusan elküldjön egy linket egy új interfész beállításához.
Lépésről lépésre
Prior to r383, Service Accounts were called "API Tokens".
A Stations API beállítása
Ebben a cikkben olvashatja el, hogyan kell beállítani egy szolgáltatási fiókot.
If you have a Service Account already set up, you may use that API Key and Secret
- A Fiókbeállítások menüben válassza ki a Tulip API fület.
- Kattintson a Szolgáltatási fiók létrehozása gombra.
- Adjon nevet a szolgáltatási fiókjának.
- A Hatályoknál válassza ki
a stations: readésa stations: writelehetőségeket:
Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.
- Kattintson a Mentés gombra.
A Stations API használata
A Stations API beállítása után létrehozhat egy állomást. Ez a példa a Postman alkalmazást használja a létrehozáshoz.
- Adja hozzá az API végpontját a Post kéréshez.
- 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ő:
A kérés összeállításakor adja meg a munkaterületet. Példa:<your-instance-name>.tulip.co/api/stations/v1/w/1/stations Ez a példa a stations végpontot célozza meg. Ha nincs munkaterülete, akkor állítsa be 1-re.
- Kattintson a „Küldés” gombra a kérés futtatásához, és a siker jelzésére 200-as választ kap.
Az ellenőrzéshez lépjen a „Stations” oldalra, a „Shop Floor” fülre, és győződjön meg arról, hogy az állomás létrejött.
