Hur använder och konfigurerar man LWS Client API?

Procédure

LWS Client-API:n är en gateway som är utformad för att underlätta integreringen med de tjänster och produkter som erbjuds av LWS (Ligne Web Services). Med detta API kan användare effektivt beställa och hantera sina tjänster, såsom köp av webbhotell, ändring av DNS och mycket mer.

I denna dokumentation guidar vi dig genom de steg som krävs för att få din API-nyckel och börja använda Client API:s funktioner. Även om den främst vänder sig till utvecklare kan även en nybörjare använda den.

Autentisera mot API:et

Generera API-nyckeln

För att förhindra missbruk av API:et behöver du skaffa en API-nyckel kopplad till ditt LWS-konto samt definiera en eller flera IP-adresser som får använda API:et. Det är obligatoriskt att ha ett LWS-konto för att kunna använda API:et. Om du inte har det, gå till den officiella LWS-webbplatsen för att registrera dig som ny kund.

För att få din API-nyckel, logga in på ditt konto via LWS Panel och gå till sidan "Api LWS" genom att klicka på ditt LWS-nummer (LWS-XXXXXX) uppe till höger.

På denna sida kan du se alla IP-adresser som får använda API:et med dina uppgifter samt saldot på ditt förbetalda konto, som kan användas för att köpa eller förnya dina domäner och webbhotell som köpts via API:et. För att generera din API-nyckel klickar du på knappen "se" mittemot alternativet "API-nyckel i PRODUKTIONSläge" för att öppna en modal där du kan generera den.

Klicka här på knappen för att generera nyckeln. Förvara den noggrant så att du inte förlorar den. Om du vill generera en ny, gå tillbaka till denna modal och klicka på knappen igen.

Denna nyckel gör det möjligt att använda hela API:et i normalt 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 de i Produktion, helt enkelt genom att klicka på "se" bredvid raden "API-nyckel i TEST-läge". Det är inte möjligt att använda testnyckeln i produktion och vice versa.

Tillåt åtkomst från en IP-adress

Det andra steget för att kunna använda LWS API är att tillåta en eller flera IP-adresser att använda API:et. Detta är en extra skyddsmetod så att en person som lyckas komma över din nyckel inte kan göra oönskade beställningar, såsom att köpa domäner i ditt ställe.

Detta görs på samma plats som för API-nyckeln; klicka denna gång på knappen "Lägg till en IP-adress" för att öppna fönstret för att lägga till IP.

I detta fönster väljer du "Produktion" och anger sedan din IP-adress. Om du inte känner till den kan du använda en webbplats för att ta reda på din aktuella IP. Beroende på nätverket du är ansluten till kan din IP 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:n för att använda den i testläge, välj i stället "Test".

När det har validerats kan du se och ta bort de IP-adresser som för närvarande är tillåtna 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 några.

Använda LWS Client-API

Du hittar den officiella dokumentationen, med listan över alla tillgängliga kommandon och användningsexempel för att upptäcka 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. Varje sida består av flera delar; överst på sidan finns en sammanfattning av åtgärden samt den URL som ska användas för detta kommando:

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

Om andra parametrar krävs, särskilt i begärans kropp, anges de också i kategorin "body".

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

För en avancerad användare är detta allt som behövs för att bekvämt använda API:et. Men för att kunna erbjuda API:et till så många som möjligt, oavsett om de är nybörjare eller experter, finns användningsexempel tillgängliga i flera programmeringsspråk, såsom PHP:

Här handlar det om ett exempel på ett cURL-kommando som ska köras i Terminal. Fälten X-Auth-Login och X-Auth-Path ska fyllas i med, respektive, ditt LWS-ID och din API-nyckel, som erhölls tidigare.

Fältet X-Test-Mode är valfritt och kan tas bort om det inte behövs. Om det sätts till "true" låter det dig köra kommandot i en testmiljö utan att utföra några åtgärder på ditt konto. Detta kan vara användbart för att se hur API:et fungerar utan att göra ändringar på ditt konto. Du måste ange en Test-API i fältet X-Auth-Pass om du väljer att använda testläget.

Slutligen är det möjligt för dig att använda API:et direkt från dokumentationen:

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

Du får då nedan svaret från det körda kommandot :

Betalda kommandon

Även om majoriteten av kommandona är gratis kan vissa kommandon i API:et inte fungera utan förbetald kredit på kontot. Köp av en domän, förnyelse av ett webbhotell, byte av paket, ... Så snart åtgärden kräver betalning kommer motsvarande belopp att dras från din förbetalda LWS-kredit (endast vid lyckad genomförd åtgärd). Ingen återgång är möjlig när kommandot har utförts. Se till att du vet vad du gör innan du använder betalda kommandon.

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

Slutsats

Nu vet du hur man:

• Får din API-nyckel och konfigurerar de tillåtna IP-adresserna för att säkra åtkomsten till LWS Client-API.
• Använder API:et för att hantera dina tjänster hos LWS, inklusive köp av webbhotell, ändring av DNS och mycket mer.
• Utforskar den officiella dokumentationen för att upptäcka alla tillgängliga kommandon och deras specifikationer.
• Kör användningsexempel för API:et i olika programmeringsspråk, såsom PHP.
• Använder API:et i testläge för att experimentera utan att påverka ditt konto.
• Förstår att vissa kommandon är avgiftsbelagda och kräver tillräckligt förbetalt saldo på ditt konto.

Tack vare denna information är du redo att fullt ut utnyttja de möjligheter som LWS Client-API erbjuder för en optimal hantering av dina onlinetjänster. 🚀💻

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