Jak używać i konfigurować LWS Client API?

Procédure

LWS Client API to brama zaprojektowana w celu ułatwienia integracji z usługami i produktami oferowanymi przez LWS (Ligne Web Services). Ten interfejs API umożliwia użytkownikom efektywne zamawianie i zarządzanie usługami, takimi jak zakup hostingu, zmiana DNS i inne.

W tej dokumentacji przeprowadzimy Cię przez kroki wymagane do uzyskania klucza API i rozpoczęcia korzystania z funkcji Client API. Chociaż jest ona skierowana bardziej do programistów, nawet nowicjusz może z niej korzystać.

Uwierzytelnianie w API

Generowanie klucza API

Aby zapobiec nieuprawnionemu dostępowi do API, należy uzyskać klucz API powiązany z kontem LWS i zdefiniować jeden lub więcej adresów IP uprawnionych do korzystania z API. Aby korzystać z API, musisz mieć konto LWS. Jeśli go nie masz, przejdź do oficjalnej strony LWS, aby zarejestrować się jako nowy klient.

Aby uzyskać klucz API, zaloguj się na swoje konto z panelu LWS i przejdź do strony "Dane kontaktowe".

Tutaj kliknij zakładkę "LWS API", aby uzyskać dostęp do strony zarządzania dostępem API.

Na tej stronie będziesz mógł zobaczyć wszystkie adresy IP upoważnione do korzystania z API wraz z danymi logowania, a także saldo konta przedpłaconego, które można wykorzystać do zakupu lub odnowienia domen i hostingu zakupionych za pośrednictwem API. Aby wygenerować klucz API, kliknij przycisk "zobacz" przed opcją "Klucz API w trybie PRODUKCJI", aby otworzyć okno modalne umożliwiające jego wygenerowanie.

Kliknij przycisk, aby wygenerować klucz. Przechowuj go ostrożnie, aby go nie zgubić. Jeśli chcesz wygenerować nowy, wróć do tego trybu i ponownie kliknij przycisk.

Ten klucz umożliwia korzystanie z pełnego API w normalnym trybie. Jeśli chcesz korzystać z API w odizolowanym środowisku, aby je przetestować, będziesz musiał użyć klucza w trybie TEST, który możesz utworzyć w taki sam sposób, jak klucze produkcyjne, po prostu klikając "widok" obok wiersza "Klucz API w trybie TEST". Nie jest możliwe użycie klucza testowego w trybie produkcyjnym i odwrotnie.

Autoryzacja dostępu do IP

Drugim krokiem w korzystaniu z LWS API jest autoryzacja jednego lub więcej adresów IP do korzystania z API. Jest to dodatkowa metoda ochrony, aby ktoś, komu udało się zdobyć Twój klucz, nie mógł składać niechcianych zamówień, takich jak kupowanie domen dla Ciebie.

Odbywa się to w tym samym miejscu, co w przypadku klucza API; tym razem kliknij przycisk "Dodaj adres IP", aby otworzyć okno Dodaj adres IP.

W tym oknie wybierz "Produkcja" i wprowadź swój adres IP. Jeśli go nie znasz, możesz skorzystać z witryny, aby uzyskać aktualny adres IP. W zależności od sieci, do której jesteś podłączony, Twój adres IP może być inny, więc może być konieczne określenie kilku adresów IP, aby wszędzie korzystać z interfejsu API. Jeśli chcesz dodać adres IP, aby używać go w trybie testowym, wybierz opcję "Test".

Po zatwierdzeniu będziesz mógł przeglądać i usuwać adresy IP aktualnie uprawnione do korzystania z API w tabeli na stronie. Dla każdego trybu można dodać maksymalnie 3 adresy IP. Jeśli chcesz dodać więcej, musisz je usunąć.

Korzystanie z interfejsu API klienta LWS

Możesz znaleźć oficjalną dokumentację z listą wszystkich dostępnych poleceń i przykładami użycia, aby dowiedzieć się, jak korzystać z naszego API.

Wybierz kategorię i polecenie z menu po lewej stronie, aby uzyskać więcej informacji na ich temat. W górnej części strony znajduje się podsumowanie działania i adres URL, którego należy użyć dla polecenia:

Jeśli polecenie wymaga dodatkowego parametru, zostanie to wskazane poniżej, w sekcji "Żądanie". W naszym przykładzie polecenie oczekuje nazwy domeny w "PATH", adresie URL polecenia (zamiast :domain):

Jeśli wymagane są inne parametry, szczególnie w treści żądania, zostaną one również wskazane w kategorii "body".

Wszystkie polecenia zwrócą komunikat po wykonaniu. Może to być komunikat o błędzie, komunikat potwierdzający lub żądane dane (w naszym przykładzie informacje o domenie). Wszystkie możliwe zwroty dla danego polecenia można znaleźć w sekcji "Odpowiedzi" na stronie:

Dla zaawansowanego użytkownika informacje te są wszystkim, czego będzie potrzebował do wygodnego korzystania z API. Jednak w celu udostępnienia API jak największej liczbie osób, zarówno początkującym, jak i ekspertom, dostępne są przykłady użycia w kilku językach programowania, takich jak PHP :

Oto przykład polecenia cURL do wykonania w Terminalu. Pola X-Auth-Login i X-Auth-Path powinny być wypełnione odpowiednio identyfikatorem LWS i kluczem API, uzyskanym wcześniej.

Pole X-Test-Mode jest opcjonalne i może zostać usunięte, jeśli nie jest wymagane. Jeśli jest ustawione na "true", umożliwia uruchomienie polecenia w środowisku testowym bez podejmowania żadnych działań na koncie. Może to być przydatne do sprawdzenia, jak działa interfejs API bez konieczności manipulowania kontem. Jeśli zdecydujesz się użyć trybu testowego, będziesz musiał wprowadzić Test API w polu X-Auth-Pass.

Wreszcie, można korzystać z API bezpośrednio z dokumentacji:

Aby to zrobić, wprowadź swój identyfikator LWS i klucz API odpowiednio w polach ApiAuthID i ApiPasswordKey, wraz ze wszystkimi parametrami wymaganymi przez polecenie, a następnie kliknij "SEND API REQUEST". Aby uruchomić polecenie w środowisku testowym, wpisz "true" w polu TestMode.

Poniżej zostanie wyświetlony wynik wykonanego polecenia:

Polecenia płatne

Chociaż większość poleceń jest bezpłatna, niektóre polecenia API nie będą działać bez przedpłaconego kredytu na koncie. Zakup domeny, odnowienie pakietu hostingowego, zmiana pakietu itp. Gdy tylko działanie będzie wymagało płatności, zostaniesz obciążony odpowiednią kwotą z przedpłaconego kredytu LWS (tylko jeśli działanie się powiedzie). Po złożeniu zamówienia nie ma już odwrotu. Przed skorzystaniem z płatnych zamówień upewnij się, że wiesz, co robisz.

Konto przedpłacone jest obecnie jedyną metodą płatności akceptowaną przez API. Jeśli nie masz wystarczających środków na koncie, możesz je doładować na dedykowanej stronie.

Podsumowanie

Wiesz już, jak :

• Uzyskać klucz API i skonfigurować autoryzowane adresy IP w celu zabezpieczenia dostępu do interfejsuAPI klienta LWS.
• UżywaćAPI do zarządzania swoimi usługami z LWS, w tym do zakupu hostingu, zmiany DNS i wielu innych.
• Zapoznaj się z oficjalną dokumentacją, aby odkryć wszystkie dostępne polecenia i ich specyficzne funkcje.
• Uruchom przykłady korzystania z API w różnych językach programowania, takich jak PHP.
• Korzystaj z API w trybie testowym, aby eksperymentować bez wpływu na swoje konto.
• Zrozumienie, że niektóre zamówienia są płatne i wymagają wystarczającego salda przedpłaty na koncie.

Dzięki tym informacjom możesz w pełni wykorzystać możliwości oferowane przezLWS Client API do optymalnego zarządzania swoimi usługami online. 🚀💻

Dziękujemy za przeczytanie! Jeśli masz jakieś pytania lub chciałbyś podzielić się swoimi doświadczeniami z LWS Client API, nie wahaj się zostawić komentarza. Twoja opinia jest cenna dla nas i społeczności. 🤝📢