Toegang tot Invapi-account API-sleutelbeheer¶

In dit artikel

• Een API-sleutel verkrijgen voor het volledige Invapi-account
• API-sleutels beheren voor het volledige Invapi-account
• De API-sleutel gebruiken voor het volledige Invapi-account
• Informatie over het gebruik van de API-sleutel voor het volledige Invapi-account
• Een API-sleutel verkrijgen voor het volledige Invapi-account zonder een webcontrolepaneel

Een API-sleutel verkrijgen voor het volledige Invapi-account¶

1. Ga naar Invapi en klik op Username >> API keys.

2. Klik op de knop Add new om een API-sleutel te maken.

   

   • Voer in het veld Name een naam in om de sleutel te identificeren;
   • Selecteer in de vervolgkeuzelijst Restrict a new API key only for the server of de sleutel van toepassing is op het volledige account (Any) of op een specifieke server;
   • Geef de IP-adressen op vanaf welke toegang met deze sleutel is toegestaan in het veld IP ACL, of laat het leeg voor onbeperkte toegang.
   • Kies een meldingsmethode voor toegang tot het account met deze API-sleutel uit de vervolgkeuzelijst Set login notification method. Opties zijn:
     • None (geen melding);
     • E-mail
     • Webhook - verzend inloggegevens via een HTTP-aanroep naar uw website.
   • Als u E-mail of Webhook selecteert, voert u het bijbehorende e-mailadres of URL in in het veld Notification address (email/URL).
   • Vink het selectievakje Active aan om de sleutel te activeren;
   • Klik op de knop Create om een nieuwe API-sleutel toe te voegen.

   

   De API-sleutel wordt aan u getoond.

   

API-sleutels beheren voor het volledige Invapi-account¶

Om een API-sleutel te bewerken of te verwijderen, gaat u naar uw account waar deze is gegenereerd en klikt u op de gewenste sleutel. Ga in het verschijnende venster naar het tabblad General Info waar u kunt:

• de naam van de sleutel wijzigen in het veld Name;
• IP-adressen instellen vanaf welke aanroepen met de sleutel verboden zijn in het veld IP ACL;
• de meldingsmethode voor inloggen met deze API-sleutel wijzigen of instellen. Dit geldt alleen voor sleutels die voor het volledige account zijn uitgegeven en betreft het veld voor het meldingsadres (e-mail/URL);
• deze functie inschakelen of tijdelijk uitschakelen met het selectievakje Active.

Klik vervolgens op de knop Save API key om uw wijzigingen op te slaan.

Om een API-sleutel te verwijderen, klikt u op de knop Delete API key.

De API-sleutel gebruiken voor het volledige Invapi-account¶

De API-sleutel kan worden gebruikt om een sessietoken te verkrijgen dat vereist is voor daaropvolgende API-aanvragen aan een account in Invapi; autorisatie is noodzakelijk. Autorisatie kan worden verkregen via een API-sleutel voor toegang tot het volledige account of een specifieke server via de auth/login-aanroep, afhankelijk van de gebruikte API-sleutel. Als de autorisatie succesvol is en de sleutel in de database wordt gevonden, retourneert het systeem het sessietoken $HOSTKEY_TOKEN.

Informatie over het gebruik van de API-sleutel voor het volledige Invapi-account¶

Selecteer in het tabblad Usage history een specifieke sleutel voor een account en klik erop om alle inlogsessies te bekijken die met deze API-sleutel zijn gemaakt tijdens een bepaalde periode. De output bevat het e-mailadres en het IP-adres dat voor de inlogsessie is gebruikt, de status van het succes, evenals de datum en tijd van het evenement.

Een API-sleutel verkrijgen voor het volledige Invapi-account zonder een webcontrolepaneel¶

Een API-sleutel kan worden verkregen zonder het webcontrolepaneel te gebruiken door de API-methoden voor het werken met API-sleutels te gebruiken. Deze methoden kunnen worden uitgevoerd vanaf de opdrachtregel of worden ingebed in weboplossingen