Beheer van server API-sleutels¶
In dit artikel
Informatie
Een API-sleutel is een handige manier om API-aanvragen aan Invapi te autoriseren en onafhankelijk van uw controlecentrum en persoonlijke account toegang te krijgen tot het Control Panel van een specifieke server.
Om toegang te krijgen tot het volledige account of een specifieke server, genereert u een API-toegangssleutel in het persoonlijke gedeelte van het Invapi-controlepaneel. Volg deze instructies om deze te verkrijgen.
Een API-sleutel voor een specifieke server verkrijgen¶
-
Ga naar Invapi;
-
Selecteer de server waarvoor u toegang wilt tot het externe servercontrolepaneel: My Servers >> You require a server;
-
Genereer een API-sleutel:
- Navigeer naar het tabblad Configuration en kies het gedeelte API keys & control panel.
- Klik op de knop
Add new;
- Voer in het veld Name de naam van de sleutel in om deze te identificeren;
- Geef in het veld IP ACL alleen IP-adressen op vanaf welke deze sleutel toegang mag hebben, of laat het leeg voor onbeperkte toegang;
- Vink het vakje Active aan om de sleutel te activeren;
- Klik op de knop
Add new API key.
De API-sleutel wordt aan u getoond.
Let op
Kopieer en bewaar de API-sleutelwaarde, aangezien deze slechts één keer wordt weergegeven. Invapi slaat alleen de hashwaarde van de sleutel op, dus als de oorspronkelijke sleutel verloren gaat, moet deze opnieuw worden aangemaakt.
Een API-sleutel bewerken of verwijderen¶
Om een API-sleutel te bewerken of te verwijderen, navigeert u naar uw account of een specifieke server 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 oproepen met de sleutel zijn toegestaan in het veld IP ACL;
- de methode van melding voor het inloggen met deze API-sleutel wijzigen of instellen. Dit geldt alleen voor sleutels die zijn uitgegeven voor het volledige account 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.
Let op
De API-sleutel kan niet worden hersteld zodra deze is verwijderd.
Een API-sleutel gebruiken¶
De API-sleutel kan op de volgende manieren worden gebruikt:
-
Om een sessietoken te verkrijgen dat vereist is voor daaropvolgende API-aanvragen aan een account of server in Invapi, is autorisatie noodzakelijk. Autorisatie kan worden verkregen via een API-sleutel voor toegang tot het volledige account of een specifieke server via de auth/login-oproep, 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. -
Om toegang te krijgen tot het Server Control Panel, wat servertoegang mogelijk maakt zonder in te loggen op uw Invapi Control Center-account, en om dit als een zelfstandig module in uw factureringssysteem te integreren voor het beheren van HOSTKEY-servers, moet u server-specifieke API-sleutels genereren.
Informatie over API-sleutelgebruik¶
In het tabblad Usage history selecteert u een specifieke sleutel voor een account of server en klikt u erop om alle inlogpogingen met deze API-sleutel tijdens een bepaalde periode te bekijken. De output bevat het e-mailadres en het IP-adres dat voor de inlogpoging is gebruikt, de status van het succes, evenals de datum en tijd van het evenement.
Een API-sleutel verkrijgen zonder een webpaneel¶
Een API-sleutel kan worden verkregen zonder gebruik te maken van het webcontrolepaneel door de API-methoden voor het werken met API-sleutels te gebruiken. Deze methoden kunnen worden uitgevoerd vanaf de opdrachtregel of worden geïntegreerd in weboplossingen