Hur använder och konfigurerar jag LWS Client API?

Procédure

LWS Client API är en gateway som är utformad för att underlätta integration med de tjänster och produkter som erbjuds av LWS (Ligne Web Services). API:et gör det möjligt för användare att på ett effektivt sätt beställa och hantera sina tjänster, t.ex. köpa hosting, ändra DNS och mycket mer.

I den här dokumentationen guidar vi dig genom de steg som krävs för att få din API-nyckel och börja använda Client API-funktionerna. Även om den riktar sig mer till utvecklare kan även en nybörjare använda den.

Autentisera dig till API:et

Generera API-nyckeln

För att förhindra missbruk av API:et måste du skaffa en API-nyckel som är kopplad till ditt LWS-konto och definiera en eller flera IP-adresser som är behöriga att använda API:et. Du måste ha ett LWS-konto för att kunna använda API:et. Om du inte har ett konto kan du gå till LWS officiella webbplats och registrera dig som ny kund.

För att få din API-nyckel loggar du in på ditt konto från LWS-panelen och går till sidan "Kontaktuppgifter".

Här klickar du på fliken "LWS API" för att komma åt sidan för API-åtkomsthantering.

På den här sidan kan du se alla IP-adresser som har behörighet att använda API:et med dina inloggningsuppgifter samt saldot på ditt förbetalda konto, som kan användas för att köpa eller förnya domäner och hosting som köpts via API:et. För att generera din API-nyckel klickar du på knappen "visa" framför alternativet "API-nyckel i PRODUKTIONSläge" för att öppna en modal som gör att du kan generera den.

Här klickar du på knappen för att generera nyckeln. Förvara den försiktigt så att du inte tappar bort den. Om du vill generera en ny nyckel återgår du till det här läget och klickar på knappen igen.

Med den här nyckeln kan du använda hela API:et i dess normala läge. Om du vill använda API:et i en isolerad miljö, för att testa det, måste du använda en nyckel i TEST-läge, som du kan skapa på samma sätt som produktionsnycklarna, helt enkelt genom att klicka på "visa" mittemot raden "API-nyckel i TEST-läge". Det är inte möjligt att använda testnyckeln i produktion och vice versa.

Auktorisera åtkomst till en IP

Det andra steget i användningen av LWS API är att auktorisera en eller flera IP-adresser att använda API:et. Detta är en extra skyddsmetod så att någon som har lyckats få tag på din nyckel inte kan göra oönskade beställningar, till exempel köpa domäner åt dig.

Detta sker på samma ställe som för API-nyckeln, men den här gången klickar du på knappen "Lägg till en IP-adress" för att öppna fönstret Lägg till IP.

I det här fönstret väljer du "Produktion" och anger din IP-adress. Om du inte vet det kan du använda en webbplats för att få din nuvarande IP. Beroende på vilket nätverk du är ansluten till kan din IP-adress vara annorlunda, så du kan behöva ange flera IP-adresser för att kunna använda API:et överallt. Om du vill lägga till IP för att använda det i testläge väljer du "Test" istället.

När du har validerat kan du visa och ta bort de IP-adresser som för närvarande har behörighet att använda API:et i en tabell på sidan. Upp till 3 IP-adresser kan läggas till för varje läge. Om du vill lägga till fler måste du ta bort dem.

Använda API:et för LWS-klienten

I den officiella dokumentationen finns en lista över alla tillgängliga kommandon och exempel på hur de används, så att du kan lära dig hur du använder vårt API.

Välj en kategori och ett kommando i menyn till vänster för att få mer information om dem. Längst upp på sidan finns en sammanfattning av åtgärden och den URL som ska användas för kommandot:

Om kommandot kräver ytterligare en parameter anges detta nedan i avsnittet "Request". I vårt exempel förväntar sig kommandot ett domännamn i "PATH", kommandots URL (i stället för :domain):

Om andra parametrar krävs, i synnerhet i meddelandetexten, kommer de också att anges i kategorin "body".

Alla kommandon returnerar ett meddelande när de körs. Det kan vara ett felmeddelande, ett bekräftelsemeddelande eller de begärda uppgifterna (i vårt exempel information om domänen). Du kan hitta alla möjliga svar för ett visst kommando i avsnittet "Responses" på sidan:

För en avancerad användare är den här informationen allt som behövs för att använda API:et på ett bekvämt sätt. För att göra API:et tillgängligt för så många som möjligt, både nybörjare och experter, finns det dock exempel på hur det kan användas i flera programmeringsspråk, t.ex. PHP :

Här är ett exempel på ett cURL-kommando som ska köras i terminalen. Fälten X-Auth-Login och X-Auth-Path ska fyllas i med ditt AWS-ID respektive din API-nyckel, som du fick tidigare.

Fältet X-Test-Mode är valfritt och kan tas bort om det inte behövs. Om det är inställt på "true" kan du köra kommandot i en testmiljö utan att vidta några åtgärder på ditt konto. Detta kan vara användbart för att se hur API:et fungerar utan att behöva manipulera ditt konto. Du måste ange ett test-API i fältet X-Auth-Pass om du väljer att använda testläget.

Slutligen kan du använda API:et direkt från dokumentationen:

För att göra detta anger du ditt AWS-ID och din API-nyckel i fälten ApiAuthID respektive ApiPasswordKey, tillsammans med alla parametrar som krävs för kommandot, och klickar sedan på "SEND API REQUEST". För att köra kommandot i testmiljön anger du "true" i fältet TestMode.

Du kommer då att se nedan hur kommandot returneras när det körs:

Avgiftsbelagda kommandon

Även om de flesta kommandon är gratis fungerar vissa API-kommandon inte utan förbetald kredit på kontot. Köpa en domän, förnya ett hostingpaket, ändra ett paket osv. Så snart åtgärden kräver betalning kommer du att debiteras motsvarande belopp från din förbetalda LWS-kredit (endast om åtgärden lyckas). Det finns ingen återvändo när beställningen väl har gjorts. Se till att du vet vad du gör innan du använder betalda beställningar.

Det förbetalda kontot är för närvarande den enda betalningsmetoden som accepteras av API. Om du inte har tillräckligt med pengar på ditt konto kan du fylla på det på den dedikerade sidan.

Slutsats

Du vet nu hur du gör för att :

• Skaffa din API-nyckel och konfigurera de auktoriserade IP-adresserna för att säkra åtkomsten tillLWS Client API.
• AnvändaAPI:et för att hantera dina tjänster med LWS, inklusive att köpa hosting, ändra DNS och mycket mer.
• Utforska den officiella dokumentationen för att upptäcka alla tillgängliga kommandon och deras specifika funktioner.
• Kör exempel på hur du använder API:et i olika programmeringsspråk, t.ex. PHP.
• Använd API:et i testläge för att experimentera utan att påverka ditt konto.
• Förstå att vissa beställningar är avgiftsbelagda och kräver ett tillräckligt förbetalt saldo på ditt konto.

Med denna information är du redo att dra full nytta av de möjligheter som erbjuds avLWS Client API för optimal hantering av dina onlinetjänster. 🚀💻

Tack för att du läste! Om du har några frågor eller vill dela med dig av din erfarenhet av LWS Client API, tveka inte att lämna en kommentar. Din feedback är värdefull för oss och samhället. 🤝📢