Invapi account toegang API Keys beheer¶

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 API-sleutelgebruik voor het volledige Invapi-account

Een API-sleutel verkrijgen voor het volledige Invapi-account zonder web-controlpaneel

De API-sleutel dient als een handig middel voor authenticatie voor naadloze toegang tot API-verzoeken naar Invapi.

Let op

Het verkrijgen van een account-API-sleutel is alleen mogelijk als het account een positief (niet-nul) saldo heeft.

De API-toegangssleutel wordt gegenereerd in het persoonlijke account van het Invapi controlepaneel voor toegang tot het volledige account of tot een specifieke server. Volg deze instructies om een API-sleutel voor het account te verkrijgen:

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

Navigeer naar Invapi en klik op Username >> API keys.
Klik op de knop ~~New API key~~ om een API-sleutel aan te maken.
- Voer in het veld Name de naam van de sleutel in om deze 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;
- Specificeer de IP-adressen van waaruit toegang is toegestaan met behulp van deze sleutel in het veld IP ACL, of laat het leeg voor onbeperkte toegang.
- Kies in de vervolgkeuzelijst Set login notification method een methode voor meldingen bij toegang tot het account met deze API-sleutel. De opties zijn:
  - None (geen melding);
  - E-mail
  - Webhook - stuur inloginformatie via een HTTP-aanroep naar uw website.
- Als u E-mail of Webhook selecteert, voert u het bijbehorende e-mailadres of de URL in het veld Notification address (email/URL) in.
- Om de sleutel te activeren, vinkt u het selectievakje Active aan;
- Om een nieuwe API-sleutel toe te voegen, klikt u op de knop met de tekst ~~Create~~.
De API-sleutel wordt aan u getoond.

Let op

Zorg ervoor dat u de waarde van de API-sleutel kopieert en opslaat, aangezien deze slechts eenmaal wordt getoond. Invapi slaat alleen de hashwaarde van de sleutel op, dus als de originele sleutel verloren gaat, moet deze opnieuw worden aangemaakt.

API-sleutels beheren voor het volledige Invapi-account¶

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

de naam van de sleutel wijzigen in het veld Name;
IP-adressen instellen van waaruit aanroepen met de sleutel worden verboden in het veld IP ACL;
de methode voor meldingen bij het inloggen met deze API-sleutel wijzigen of instellen. Dit geldt alleen voor sleutels die voor het volledige account zijn uitgegeven en heeft betrekking op het veld Notification address (email/URL);
deze functie in- of tijdelijk uitschakelen met behulp van het Active selectievakje.

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~~.

Let op

De API-sleutel kan niet worden hersteld nadat deze is verwijderd.

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-verzoeken naar een account in Invapi; autorisatie is noodzakelijk. Autorisatie kan worden verkregen via een API-sleutel voor toegang tot ofwel 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, geeft het systeem het sessietoken $HOSTKEY_TOKEN terug.

Informatie over API-sleutelgebruik voor het volledige Invapi-account¶

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

Een API-sleutel verkrijgen voor het volledige Invapi-account zonder web-controlpaneel¶

Een API-sleutel kan worden verkregen zonder gebruik te maken van het web-controlpaneel door gebruik te maken van de API-methoden voor het werken met API-sleutels. Deze methoden kunnen worden uitgevoerd via de opdrachtregel of worden ingebed in weboplossingen.