Hogyan hozok létre API-kulcsot a Service Desk REST API-jához?

Ha egy külső rendszernek – webshopnak, monitorozónak, saját alkalmazásnak – jegyeket kell létrehoznia vagy olvasnia, adj neki API-kulcsot. A Admin fül API-kulcsok oldalán hozod létre.

Lépések

app.topyn.hu/tickets/admin/api-keys

12

1. Nyisd meg az API-kulcsok oldalt, és kattints az Új kulcs gombra.
2. Adj a kulcsnak beszédes Név mezőt 1, például a rendszer nevét.
3. Jelöld be a szükséges Jogosultságok 2: - Jegyek olvasása; - Jegy létrehozása; - Hozzászólás; - Állapot módosítása; - Mellékletek feltöltése; - Belső jegyzetek olvasása. Csak annyit adj, amennyi a rendszernek tényleg kell.
4. Ha a kulcs csak bizonyos deskekhez férhet hozzá, válaszd ki őket (Deskek (üresen: minden)).
5. Ha kell, adj meg lejáratot (Lejárat (nem kötelező)).
6. Kattints a Létrehozás gombra.
7. Másold ki a megjelenő kulcsot, és tedd biztonságos helyre.

Kulcs visszavonása

A listában minden kulcs mellett látod az utolsó 4 karakterét és az utolsó használat idejét. A Visszavonás gombbal a kulcs azonnal és véglegesen érvénytelen lesz.

Hogyan használja a külső rendszer?

A REST API címe https://api.topyn.hu/api/ext/v1, a kulcsot a kérések Authorization: Bearer … fejlécében kell küldeni. Az API-n a rendszer lekérdezheti a deskeket, a kéréstípusokat és a mezőiket, jegyet hozhat létre, olvashatja és megválaszolhatja, léptetheti, és csatolmányt tölthet fel – amit a kulcs jogosultságai engednek. Kulcsonként percenként legfeljebb 300 kérés fogadható.