Hoe gebruik en configureer ik de LWS Client API?

Procédure

De LWS Client API is een gateway die is ontworpen om integratie met de diensten en producten van LWS (Ligne Web Services) te vergemakkelijken. Met deze API kunnen gebruikers op efficiënte wijze hun diensten bestellen en beheren, zoals het aanschaffen van hosting, het wijzigen van DNS en meer.

In deze documentatie leiden we je door de stappen die nodig zijn om je API-sleutel te verkrijgen en de Client API-functies te gaan gebruiken. Hoewel het meer gericht is op ontwikkelaars, kan zelfs een beginner het gebruiken.

Authenticeren bij de API

De API-sleutel genereren

Om onrechtmatige toegang tot de API te voorkomen, moet je een API-sleutel verkrijgen die is gekoppeld aan je LWS-account en een of meer IP's definiëren die de API mogen gebruiken. Je moet een LWS account hebben om de API te kunnen gebruiken. Als je er geen hebt, ga dan naar de officiële LWS-website om je als nieuwe klant te registreren.

Om je API-sleutel te verkrijgen, log je in op je account via het LWS-paneel en ga je naar de pagina "Contactgegevens".

Klik hier op de tab "LWS API" om naar de API toegangsbeheerpagina te gaan.

Op deze pagina kunt u alle IP's zien die geautoriseerd zijn om de API te gebruiken met uw inloggegevens, evenals het saldo van uw prepaid account, dat kan worden gebruikt om domeinen en hosting aan te schaffen of te verlengen die via de API zijn aangeschaft. Om uw API-sleutel te genereren, klikt u op de knop "weergeven" voor de optie "API-sleutel in PRODUCTIE modus" om een modal te openen waarmee u de sleutel kunt genereren.

Klik hier op de knop om de sleutel te genereren. Bewaar deze zorgvuldig zodat u hem niet kwijtraakt. Als u een nieuwe wilt genereren, keert u terug naar deze modus en klikt u opnieuw op de knop.

Met deze sleutel kun je de volledige API in de normale modus gebruiken. Als je de API in een geïsoleerde omgeving wilt gebruiken om hem te testen, moet je een sleutel in TEST-mode gebruiken, die je op dezelfde manier kunt aanmaken als de productiesleutels, door simpelweg op "view" te klikken tegenover de regel "API key in TEST-mode". Het is niet mogelijk om de testsleutel in productie te gebruiken en omgekeerd.

Toegang tot een IP autoriseren

De tweede stap in het gebruik van de LWS API is het autoriseren van een of meer IP's om de API te gebruiken. Dit is een extra beschermingsmethode zodat iemand die je sleutel in handen heeft gekregen geen ongewenste bestellingen kan doen, zoals domeinen voor je kopen.

Dit gebeurt op dezelfde plaats als voor de API-sleutel; deze keer klikt u op de knop "Een IP-adres toevoegen" om het venster IP toevoegen te openen.

Selecteer in dit venster "Productie" en voer je IP-adres in. Als je het niet weet, kun je een site gebruiken om je huidige IP-adres op te vragen. Afhankelijk van het netwerk waarmee je verbonden bent, kan je IP anders zijn, dus het kan zijn dat je meerdere IP's moet opgeven om de API overal te kunnen gebruiken. Als je het IP wilt toevoegen om het in Test modus te gebruiken, selecteer dan "Test".

Na validatie kun je de IP's die momenteel geautoriseerd zijn om de API te gebruiken, bekijken en verwijderen in een tabel op de pagina. Er kunnen maximaal 3 IP's worden toegevoegd voor elke modus. Als je er meer wilt toevoegen, moet je ze verwijderen.

De LWS Client API gebruiken

Je kunt de officiële documentatie vinden, met een lijst van alle beschikbare commando's en gebruiksvoorbeelden, om uit te vinden hoe je onze API kunt gebruiken.

Selecteer een categorie en een commando uit het menu aan de linkerkant voor meer informatie. Bovenaan de pagina staat een samenvatting van de actie en de URL die moet worden gebruikt voor de opdracht:

Als de opdracht een extra parameter vereist, wordt dit hieronder aangegeven, in het gedeelte "Aanvraag". In ons voorbeeld verwacht de opdracht een domeinnaam in het "PATH", de URL van de opdracht (in plaats van :domain):

Als er andere parameters nodig zijn, met name in de body van het verzoek, worden deze ook aangegeven in de categorie "body".

Alle commando's geven een bericht terug als ze worden uitgevoerd. Dit kan een foutbericht zijn, een bevestigingsbericht of de gevraagde gegevens (in ons voorbeeld informatie over het domein). Je kunt alle mogelijke terugmeldingen voor een bepaalde opdracht vinden in het gedeelte 'Reacties' van de pagina:

Voor een gevorderde gebruiker is deze informatie alles wat hij nodig heeft om de API comfortabel te gebruiken. Echter, om de API beschikbaar te maken voor zoveel mogelijk mensen, zowel beginners als experts, zijn er voorbeelden beschikbaar in verschillende programmeertalen, zoals PHP :

Hier is een voorbeeld van een cURL commando dat in de Terminal wordt uitgevoerd. De velden X-Auth-Login en X-Auth-Path moeten worden ingevuld met respectievelijk je LWS ID en je eerder verkregen API-sleutel.

Het veld X-Test-Mode is optioneel en kan worden verwijderd als het niet nodig is. Als het is ingesteld op "true", kun je het commando in een testomgeving uitvoeren zonder actie te ondernemen op je account. Dit kan handig zijn om te zien hoe de API werkt zonder je account te hoeven manipuleren. Je moet een Test API invoeren in het X-Auth-Pass veld als je de testmodus wilt gebruiken.

Tot slot kunt u de API rechtstreeks vanuit de documentatie gebruiken:

Om dit te doen, voer je je LWS ID en API-sleutel in respectievelijk de velden ApiAuthID en ApiPasswordKey in, samen met alle parameters die nodig zijn voor de opdracht en klik je vervolgens op "SEND API REQUEST". Voer "true" in het veld TestMode in om de opdracht in de testomgeving uit te voeren.

Je ziet dan hieronder het resultaat van de opdracht die is uitgevoerd:

Betaalde opdrachten

Hoewel de meeste commando's gratis zijn, werken sommige API commando's niet zonder vooruitbetaald tegoed op de account. Een domein kopen, een hostingpakket verlengen, een pakket wijzigen, enz. Zodra de actie betaling vereist, wordt het corresponderende bedrag van je LWS prepaid tegoed afgeschreven (alleen als de actie succesvol is). Er is geen weg meer terug als de bestelling eenmaal is geplaatst. Zorg ervoor dat je weet wat je doet voordat je betaalde bestellingen gebruikt.

De prepaid account is momenteel de enige betaalmethode die door de API wordt geaccepteerd. Als je niet genoeg geld op je account hebt staan, kun je dit opwaarderen op de speciale pagina.

Conclusie

U weet nu hoe u :

• Je API-sleutel verkrijgt en de geautoriseerde IP's configureert om de toegang tot deLWS Client API te beveiligen.
• Gebruik deAPI om je diensten met LWS te beheren, inclusief het aanschaffen van hosting, het wijzigen van DNS en nog veel meer.
• Verken de officiële documentatie om alle beschikbare commando's en hun specifieke functies te ontdekken.
• Bekijk voorbeelden van het gebruik van de API in verschillende programmeertalen, zoals PHP.
• Gebruik de API in testmodus om te experimenteren zonder uw account te beïnvloeden.
• Begrijpen dat voor sommige bestellingen kosten in rekening moeten worden gebracht en dat hiervoor voldoende saldo op je account moet staan.

Met deze informatie bent u helemaal klaar om de mogelijkheden van deLWS Client API ten volle te benutten voor een optimaal beheer van uw online services. 🚀💻

Bedankt voor het lezen! Als je vragen hebt of je ervaring met de LWS Client API wilt delen, aarzel dan niet om een reactie achter te laten. Uw feedback is waardevol voor ons en de gemeenschap. 🤝📢