Hogyan adok API-kulcsot egy külső eszköznek a Munkához?

A Beállítások › Munka oldal API-kulcsok kártyáján jogkörökkel és projektekre szűkítve hozol létre kulcsot; a külső eszköz ezzel olvas munkaelemet, léptet állapotot, megjegyzést és bizonyítékot ír.

Frissítve: 2026. október 2.

Egy külső eszköz – például egy CI-rendszer vagy egy hibakövető – API-kulccsal kapcsolódhat a Munkához. A kulcsot a Beállítások › Munka oldal API-kulcsok kártyáján, az Új kulcs gombbal hozod létre; a teljes kulcs csak egyszer, a létrehozás után látszik.

Kulcs létrehozása

Az Új kulcs ablak kitöltött Név mezővel, a négy jogkör jelölőnégyzetével és a Projektek résszel

Nyisd meg a Beállítások Ügyfélszolgálat és tartalom csoportjában a Munka oldalt, és a API-kulcsok kártyán kattints az Új kulcs gombra.
Adj a kulcsnak egy beszédes nevet (Név) 1, például annak az eszköznek a nevét, amelyik használja.
Válaszd ki a Jogkörök mezőben, mit tehet a kulcs 2 (a jogkörök jelentését lásd alább).
A Projektek részben 3 pipáld ki azokat a projekteket, amelyeket a kulcs elérhet. Ha egyet sem jelölsz ki, a kulcs minden projektet elér.
Kattints a Kulcs létrehozása gombra.
A következő ablakban másold ki a kulcsot a Másolás gombbal, és tárold biztonságos helyen. Pipáld ki a Biztonságos helyen eltároltam négyzetet, és zárd be.

A jogkörök:

work:read – munkaelemek és a lehetséges állapotlépések olvasása (alapból bejelölve);
work:status – állapotlépés végrehajtása;
work:comment – megjegyzés írása;
work:evidence – bizonyíték csatolása egy kritériumhoz.

A teljes kulcs csak ebben az ablakban látszik. Bezárás után a listában már csak a vége (wrk_…) azonosítja; ha elveszett, vond vissza a kulcsot, és hozz létre újat.

A kulcsok listája

A kártyán minden kulcsnál látod a nevét, a végét, a jogköreit, a Minden projekt jelölést, ha nincs projektre szűkítve, és hogy mikor használták utoljára. A Visszavonás gomb megerősítés után azonnal letiltja a kulcsot – ami használja, onnantól leáll.

Hogyan használja a külső eszköz?

Cím: https://api.topyn.hu/api/ext/v1
A kulcsot minden kérés Authorization fejlécében kell küldeni: Bearer wrk_…
Kulcsonként percenként legfeljebb 300 kérés mehet.

GET  /work/items                                   work:read
GET  /work/items/{kulcs}                           work:read
GET  /work/items/{kulcs}/transitions               work:read
POST /work/items/{kulcs}/transitions               work:status
POST /work/items/{kulcs}/comments                  work:comment
POST /work/items/{kulcs}/criteria/{id}/evidence    work:evidence

A külső eszköz minden írása bekerül a változásnaplóba, és a munkaelemen külső eszköz jelölést kap. Fejléc nélküli kérésre a válasz 401, ismeretlen vagy visszavont kulcsra 404.

A kártyát a Munka beállítására jogosultak látják: Tulajdonos és Menedzser. A kulcs csak addig működik, amíg a Munka modul be van kapcsolva a workspace-ben.

Kapcsolódó

Hasznos volt?

Kipróbálom ingyen