Jak používat a nakonfigurovat API Client LWS ?

Procédure

L'API Client LWS je brána navržená tak, aby usnadnila integraci se službami a produkty nabízenými společností LWS (Ligne Web Services). Toto API umožňuje uživatelům efektivně objednávat a spravovat své služby, jako je nákup hostingů, změna DNS a další.

V této dokumentaci vás provedeme kroky nezbytnými k získání vašeho API klíče a k začátku používání funkcí Client API. [PERSON_NAME] více zaměřené na vývojáře, může jej používat i [PERSON_NAME].

Ověření v API

Vygenerovat API klíč

Abyste zabránili zneužívajícímu přístupu k API, budete muset získat API klíč propojený s vaším účtem LWS a zároveň definovat jednu nebo více IP adres oprávněných používat API. Pro používání API je povinné mít účet LWS. Pokud jej nemáte, přejděte na oficiální web LWS a zaregistrujte se jako nový klient.

Pro získání vašeho API klíče se přihlaste ke svému účtu přes LWS Panel a přejděte na stránku "Api LWS" kliknutím na své číslo LWS (LWS-XXXXXX) vpravo nahoře.

Na této stránce uvidíte všechny IP adresy oprávněné používat API s vašimi přihlašovacími údaji, stejně jako zůstatek vašeho předplaceného účtu, který lze použít k nákupu nebo obnovení vašich domén a hostingů zakoupených přes API. Pro vygenerování vašeho API klíče klikněte na tlačítko "voir" naproti možnosti "Clé API en mode PRODUCTION", čímž otevřete modální okno pro jeho generování.

Zde klikněte na tlačítko pro vygenerování klíče. Uložte si jej pečlivě, abyste jej neztratili. [PERSON_NAME], vraťte se do tohoto modálního okna a klikněte na tlačítko znovu.

Tento klíč umožňuje používat kompletní API v jeho běžném režimu. Pokud chcete používat API v izolovaném prostředí za účelem testování, budete muset použít klíč v TEST režimu, který můžete vytvořit stejným způsobem jako klíče v produkci, jednoduše kliknutím na "voir" naproti řádku "Clé API en mode TEST". Není možné použít testovací klíč v produkci a naopak.

[PERSON_NAME]>

[ADDRESS] možnost používat API LWS je povolení jedné nebo více IP adres k používání API. Jde o dodatečnou ochrannou metodu, aby osoba, která se dostane k vašemu klíči, nemohla provádět nechtěné objednávky, například nakupovat domény vaším jménem.

[PERSON_NAME] jde na stejné místo jako u API klíče; tentokrát klikněte na tlačítko "Ajouter une adresse IP", abyste otevřeli okno pro přidání IP.

V tomto okně vyberte "Production" a poté zadejte svou IP adresu. [PERSON_NAME], můžete použít webovou stránku pro získání své aktuální IP. V závislosti na síti, ke které jste připojeni, se vaše IP může lišit, takže možná budete muset uvést více IP adres, abyste mohli API používat všude. Pokud chcete přidat IP pro použití v Test režimu, vyberte místo toho "Test".

Po potvrzení si budete moci zobrazit a smazat aktuálně povolené IP adresy k používání API v tabulce na stránce. Pro každý režim lze přidat až 3 IP adresy. Pokud chcete přidat další, budete je muset odstranit.

Používání LWS Client API

Můžete najít oficiální dokumentaci se seznamem všech dostupných příkazů a příklady použití, abyste zjistili, jak naše API používat.

Vyberte kategorii a příkaz v levém menu, abyste získali více informací o nich. Každá stránka se skládá z několika částí; horní část stránky obsahuje shrnutí akce a URL, kterou je třeba pro tento příkaz použít:

V případě, že příkaz vyžaduje další parametr, bude uveden níže, [ADDRESS] část "Request". V našem příkladu [ADDRESS] očekává název domény v "PATH", URL příkazu (místo :domain) :

V případě, že jsou potřeba další parametry, zejména v těle požadavku, budou rovněž uvedeny [ADDRESS] kategorii "body".

Všechny příkazy vrátí po provedení zprávu. [PERSON_NAME] může být chybová zpráva, potvrzení nebo požadovaná data (v našem příkladu informace o doméně). Všechny možné návraty konkrétního příkazu najdete v části "Responses" na stránce:

Pro [PERSON_NAME] jsou tyto informace vše, co bude potřebovat k pohodlnému používání API. Nicméně s cílem nabídnout API co největšímu počtu lidí, [PERSON_NAME] ať už jsou začátečníci nebo experti, jsou k dispozici příklady použití v několika programovacích jazycích, například v PHP:

Zde se jedná o příklad příkazu cURL, který je třeba spustit v Terminálu. Pole X-Auth-Login a X-Auth-Path je nutné vyplnit vaším LWS ID a vaším API klíčem, získaným dříve.

Pole X-Test-Mode je volitelné a lze jej odstranit, pokud není potřeba. Pokud je nastaveno na "true", umožňuje spustit příkaz v testovacím prostředí bez provedení akcí na vašem účtu. [PERSON_NAME] jak API funguje, aniž by docházelo k zásahům do vašeho účtu. Pokud se rozhodnete použít testovací režim, budete muset do pole X-Auth-Pass zadat testovací API.

[PERSON_NAME], API můžete používat přímo z dokumentace:

Za tímto účelem vyplňte své LWS ID a svůj API klíč do polí ApiAuthID a ApiPasswordKey, stejně jako všechny parametry požadované příkazem, a poté klikněte na "SEND API REQUEST". [PERSON_NAME] test, vyplňte do pole TestMode hodnotu "true".

Poté se vám níže zobrazí odpověď provedeného příkazu:

Placené příkazy

[PERSON_NAME], některé příkazy API nebudou fungovat bez předplaceného kreditu na účtu. Nákup domény, obnovení hostingu, změna tarifu, ... Jakmile akce vyžaduje platbu, bude vám účtována odpovídající částka z vašeho předplaceného kreditu LWS (pouze v případě úspěchu akce). Po provedení příkazu není možný žádný návrat zpět. Ujistěte se, že víte, co děláte, než použijete placené příkazy.

Předplacený účet je v současnosti jedinou platební metodou akceptovanou API. [PERSON_NAME] nemáte na účtu dostatek prostředků, můžete jej dobít na věnované stránce.

Závěr

Nyní víte, jak:

• Získat svůj API klíč a nastavit povolené IP adresy pro zabezpečení přístupu k LWS Client API.
• Používat API ke správě svých služeb u LWS, včetně nákupu hostingů, změny DNS a mnohem více.
• Prozkoumat oficiální dokumentaci a zjistit všechny dostupné příkazy a jejich specifika.
• Spustit příklady použití API v různých programovacích jazycích, jako je PHP.
• Používat API v testovacím režimu k experimentování bez dopadu na [PERSON_NAME]>
• [PERSON_NAME] placené a vyžadují dostatečný předplacený zůstatek na vašem účtu.

Díky těmto informacím, [PERSON_NAME]>API Client LWS pro optimální správu vašich online služeb. 🚀💻

Děkujeme, že jste si nás přečetli! [PERSON_NAME] máte otázky nebo chcete sdílet své zkušenosti s LWS Client API, neváhejte zanechat komentář. Vaše zpětná vazba je pro nás i pro komunitu cenná. [PERSON_NAME]📢