REST API

Správci vytvářejí Bearer tokeny s definovanými scopes pro externí aplikace.

Přehled

Tato stránka popisuje obsluhu a nejdůležitější dopady funkce REST API. Pokud změny ovlivňují existující tickety, oprávnění, oznámení nebo automatizace, měly by být nejprve ověřeny v testovacím prostředí.

Typický pracovní postup

  1. Vyhledat uživatele pro token. Použijte dostupné vyhledávání, filtry a podrobné pohledy. Pokud se očekávané záznamy nezobrazí, filtry vymažte nebo změňte.

  2. Vytvořit token s názvem a scopes. Otevřete příslušný formulář správy nebo akce, zadejte požadované hodnoty a uložte je až po kontrole přiřazení a povinných polí.

  3. Bezpečně převzít hodnotu tokenu. Proveďte funkci v určeném formuláři a výsledek ihned zkontrolujte v příslušném přehledu nebo u dotčeného ticketu.

  4. Deaktivovat token. Nejprve zkontrolujte, kterých existujících záznamů nebo uživatelů se změna týká. Pokud je to možné, použijte deaktivaci místo trvalého odstranění.

  5. Porozumět protokolování požadavků a idempotenci. Proveďte funkci v určeném formuláři a výsledek ihned zkontrolujte v příslušném přehledu nebo u dotčeného ticketu.

  6. Otevřít popis OpenAPI. Proveďte funkci v určeném formuláři a výsledek ihned zkontrolujte v příslušném přehledu nebo u dotčeného ticketu.

Poznámky

  • Viditelné položky nabídky a akce závisí na oprávněních skupin a programů přihlášeného agenta.

  • Deaktivované položky často zůstávají zachovány pro stávající tickety a vyhodnocení, ale již nejsou dostupné pro nová přiřazení.

  • Po změnách otestujte alespoň jeden realistický případ použití s uživatelem dotčené role.

REST API