Az Operator API használata

Az Operator API beállításának megtanulása

:::(Info) (Haladó tartalom)Ez a cikk feltételezi az API-kkal kapcsolatos korábbi tapasztalatokat.:::

Az operátorok hozzáadása szükséges ahhoz, hogy feltöltse a Tulipban fejlesztett alkalmazásokat futtató felhasználókat. Operátorokat kétféleképpen hozhat létre:* A Beállításokban található Felhasználók oldal* Külső rendszer használata a Tulip API-n keresztül.

Az alábbi eljárás bemutatja, hogyan használhatja a Tulip API-t az operátorok létrehozásához.

Operátor API token hozzáadása

A Tulip példányában kattintson a profil ikonjára a jobb felső sarokban, és válassza a Beállítások menüpontot.

Válassza ki az API Tokeneket, majd kattintson a jobb felső sarokban lévő Create API Token gombra.

A Létrehozás menüben adjon nevet az API-tokennek, és válassza ki a users:write hatókörét. Kattintson a Létrehozás gombra.

:::(Info) (Megjegyzés)Győződjön meg róla, hogy elmentette az API Token adatait az API kulcs, a titok és az engedélyezési fejléc számára::::

Az Operator API használata

A következőkben egy operátor létrehozását tekintjük át. Ebben az esetben a példa a Postman-t fogja használni a létrehozáshoz.

Először is adja hozzá az API végpontját a Post kéréshez.

:::(Info) (MEGJEGYZÉS) Ha globális API-kulcsot használ, akkor meg kell adnia a munkaterületet. Ha az API-kulcsa munkaterületi hatókörű, akkor ez opcionális::::

https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/users

Ezután az Authorization (Engedélyezés) menüpontban válassza az Basic Auth (Alapszintű engedélyezés ) lehetőséget, és adja meg az API-kulcsot felhasználónévként, valamint az API Secret (API-titok) jelszót jelszóként.

A Fejlécek alatt adja hozzá az Auth fejlécet.

A Body alatt formázza meg a kérést úgy, hogy a JSON objektumot vegye át. A kérés általános formátuma a következő.

{"role": "operator", "name": "string", "badge_id": "string"}

Ez valahogy így fog kinézni:

Kattintson a Send gombra a kérés futtatásához, és egy 201-es választ fog kapni a sikeresség jelzésére. Az ellenőrzéshez ellenőrizheti a Felhasználók listáját a Beállításokban, és megerősítheti, hogy a felhasználó létrehozása sikeres volt.

Ha a kérés sikertelen, ellenőrizze, hogy a Kulcs és a Titok helyes-e. A konkrét válaszkódokról további információt a Bevezetés az API-kba című fejezetben talál.

Megtalálta, amit keresett?

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