Server API Key Management¶

In dit artikel

• Een API-sleutel verkrijgen voor een specifieke server
• Een API-sleutel bewerken
• Een API-sleutel verwijderen
• Een API-sleutel gebruiken
• Informatie over API-sleutelgebruik
• Een API-sleutel verkrijgen zonder webpaneel

Om toegang te krijgen tot het volledige account of een specifieke server, genereert u een API-toegangssleutel in het persoonlijke gedeelte van het Invapi control panel. Volg deze instructies om deze te verkrijgen.

Een API-sleutel verkrijgen voor een specifieke server¶

1. Ga naar Invapi;

2. Selecteer de server waarvoor u toegang wilt krijgen tot het externe server control panel: My Servers >> Vereiste server;

3. Genereer een API-sleutel:

   • Navigeer naar het tabblad Configuration en kies de sectie API keys & control panel.
   • Klik op de knop Create API key;

   

   • Voer in het veld Name de naam van de sleutel in om deze te identificeren;
   • Specificeer in het veld IP ACL alleen de IP-adressen van waaruit toegang met deze sleutel is toegestaan, of laat het veld leeg voor onbeperkte toegang;
   • Selecteer de methode voor login-notificaties (None, Email, Webhook)
   • Vink het vakje Active aan om de sleutel te activeren;
   • Klik op de knop Save.

   

   Daarna wordt uw API-sleutel weergegeven.

   

Een API-sleutel bewerken¶

Om een API-sleutel te bewerken of te verwijderen, gaat u naar uw account of een specifieke server, zoals hierboven beschreven tijdens de generatie, en klikt u op de betreffende API-sleutel. In het venster dat wordt geopend, kunt u:

• de naam van de sleutel wijzigen (Name veld);
• de IP-adressen instellen van waaruit aanroepen met de sleutel zijn toegestaan (IP ACL veld);
• deze inschakelen of tijdelijk uitschakelen (selectievakje Active).

Vervolgens kunt u op de knop Save klikken om de wijzigingen op te slaan.

Een API-sleutel verwijderen¶

Om een API-sleutel te verwijderen, gaat u naar het gebruikersprofiel - sectie API Keys

Zoek in de lijst met sleutels de sleutel die u wilt verwijderen. Klik op ....

Klik in het dropdown-menu op de knop Delete

Een API-sleutel gebruiken¶

De API-sleutel kan op de volgende manieren worden gebruikt:

1. Om een sessietoken te verkrijgen dat vereist is voor daaropvolgende API-verzoeken naar een account of server in Invapi, is autorisatie nodig. 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.

2. Om toegang te krijgen tot het Server Control Panel, waarmee servertoegang mogelijk is zonder in te loggen op uw Invapi Control Center-account, en om dit als een standalone module in uw facturatingsysteem te integreren om HOSTKEY-servers te beheren, moet u server-specifieke API-sleutels genereren.

Informatie over API-sleutelgebruik¶

Selecteer in het tabblad Usage history een specifieke sleutel voor een account of server en klik erop om alle inlogpogingen 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 zonder webpaneel¶

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