REST-API¶

Beheerders maken Bearer-tokens met vastgelegde scopes voor externe toepassingen.

Overzicht¶

Deze pagina beschrijft het gebruik en de belangrijkste gevolgen van REST-API. Als wijzigingen invloed hebben op bestaande tickets, machtigingen, meldingen of automatiseringen, moeten ze eerst in een testomgeving worden gecontroleerd.

Typische workflow¶

Gebruiker voor een token zoeken. Gebruik de beschikbare zoek-, filter- en detailweergaven. Wis of wijzig filters als verwachte records niet verschijnen.
Token met naam en scopes maken. Open het bijbehorende beheer- of actieformulier, voer de vereiste waarden in en sla pas op nadat toewijzingen en verplichte velden zijn gecontroleerd.
Tokenwaarde veilig overnemen. Voer de functie in het daarvoor bestemde formulier uit en controleer het resultaat direct in het bijbehorende overzicht of bij het betrokken ticket.
Token deactiveren. Controleer vooraf welke bestaande records of gebruikers hierdoor worden beïnvloed. Gebruik waar mogelijk deactivering in plaats van definitieve verwijdering.
Requestlogging en idempotentie begrijpen. Voer de functie in het daarvoor bestemde formulier uit en controleer het resultaat direct in het bijbehorende overzicht of bij het betrokken ticket.
OpenAPI-beschrijving openen. Voer de functie in het daarvoor bestemde formulier uit en controleer het resultaat direct in het bijbehorende overzicht of bij het betrokken ticket.

Opmerkingen¶

Zichtbare menu-items en acties zijn afhankelijk van de groeps- en programmarechten van de aangemelde agent.
Gedeactiveerde vermeldingen blijven vaak behouden voor bestaande tickets en analyses, maar zijn niet meer beschikbaar voor nieuwe toewijzingen.
Test na wijzigingen ten minste één realistische gebruikssituatie met een gebruiker van de betrokken rol.