Ismerje meg, hogyan állíthatja be az Operátor API-t
This article assumes previous experience with APIs.
Operátorok hozzáadása a webhelyéhez szükséges ahhoz, hogy feltöltse azokat a felhasználókat, akik a Tulipban fejlesztett alkalmazásokat fogják futtatni. Kétféle módon hozhat létre operátorokat:* A Beállítások menüpontban található Felhasználók oldalon * Külső rendszer használatával a Tulip API-n keresztül.
Az alábbi eljárás bemutatja, hogyan lehet a Tulip API segítségével operátorokat létrehozni.
Operátor-API-token hozzáadása
Prior to r383, Service Accounts were called "API Tokens".
A Tulip-példányában kattintson a jobb felső sarokban található profilikonra, majd válassza a Beállítások menüpontot.
Válassza a „Tulip API” menüpontot, majd kattintson a jobb felső sarokban található „Szolgáltatási fiók létrehozása” gombra.
A Létrehozás menüben adjon nevet az API-tokennak, majd válassza ki a users:write hatókört. Kattintson a Létrehozás gombra.
Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.
Az Operator API használata
Az alábbiakban bemutatjuk, hogyan lehet operátort létrehozni. Ebben az esetben a példában a Postman programot használjuk a létrehozáshoz.
Először adja hozzá az API végpontját a Post kéréshez.
If you are using a global API key, you need to specify the workspace. If your API key is workspaced scoped, it is optional.
https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/users
Ezután az Authorization (Hitelesítés) alatt válassza ki a Basic Auth (Alapvető hitelesítés) lehet ős é get, majd í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 az API-k bevezetése című részben találhatók.
Megtalálta, amit keresett?
Látogasson el a community.tulip.co oldalra is, ahol felteheti kérdését, vagy megnézheti, hogy mások is szembesültek-e hasonló problémával!