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

Procédure

L'API Client LWS jest bramą zaprojektowaną w celu ułatwienia integracji z usługami i produktami oferowanymi przez LWS (Ligne Web Services). To API umożliwia użytkownikom skuteczne zamawianie i zarządzanie swoimi usługami, takimi jak zakup hostingu, zmiana DNS i wiele więcej.

W niniejszej dokumentacji przeprowadzimy Cię przez kroki niezbędne do uzyskania klucza API i rozpoczęcia korzystania z funkcji API Client. Choć jest ona bardziej skierowana do programistów, może z niej korzystać nawet początkujący użytkownik.

Uwierzytelnianie w API

Generowanie klucza API

Aby zapobiec nadużyciom dostępu do API, będziesz musiał uzyskać klucz API powiązany z Twoim kontem LWS oraz zdefiniować jeden lub więcej dozwolonych adresów IP, które mogą korzystać z API. Posiadanie konta LWS jest obowiązkowe, aby korzystać z API. Jeśli jeszcze go nie masz, odwiedź oficjalną stronę LWS, aby zarejestrować się jako nowy klient.

Aby uzyskać klucz API, zaloguj się na swoje konto w LWS Panel i przejdź do strony „Api LWS”, klikając swój numer LWS (LWS-XXXXXX) w prawym górnym rogu.

Na tej stronie możesz zobaczyć wszystkie adresy IP dozwolone do korzystania z API przy użyciu Twoich danych uwierzytelniających, a także saldo Twojego konta przedpłaconego, które może zostać wykorzystane do zakupu lub odnowienia domen i hostingu kupionych za pośrednictwem API. Aby wygenerować klucz API, kliknij przycisk „voir” naprzeciw opcji „Clé API en mode PRODUCTION”, aby otworzyć okno modalne umożliwiające jego wygenerowanie.

Tutaj kliknij przycisk, aby wygenerować klucz. Zapisz go starannie, aby go nie zgubić. Jeśli chcesz wygenerować nowy, wróć do tego okna modalnego i kliknij ponownie przycisk.

Ten klucz umożliwia korzystanie z pełnego API w jego normalnym trybie. Jeśli chcesz używać API w odizolowanym środowisku, aby je przetestować, musisz użyć klucza w trybie TEST, który możesz utworzyć w taki sam sposób jak klucze produkcyjne, po prostu klikając „voir” przy wierszu „Clé API en mode TEST”. Nie można używać klucza testowego w produkcji i odwrotnie.

Autoryzowanie dostępu z adresu IP

Drugim krokiem, aby móc korzystać z API LWS, jest autoryzowanie jednego lub kilku adresów IP do korzystania z API. Jest to dodatkowa metoda ochrony, aby osoba, która zdobyła Twój klucz, nie mogła wykonywać niechcianych operacji, takich jak kupowanie domen w Twoim imieniu.

Odbywa się to w tym samym miejscu co w przypadku klucza API; tym razem kliknij przycisk „Ajouter une adresse IP”, aby otworzyć okno dodawania IP.

W tym oknie wybierz „Production”, a następnie wpisz swój adres IP. Jeśli go nie znasz, możesz skorzystać z jednej strony, aby uzyskać swój 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 być może będziesz musiał podać kilka adresów IP, aby korzystać z API z dowolnego miejsca. Jeśli chcesz dodać IP do użycia w trybie Test, wybierz zamiast tego „Test”.

Po zatwierdzeniu będziesz mógł przeglądać i usuwać aktualnie dozwolone adresy IP w tabeli na stronie. Dla każdego trybu można dodać maksymalnie 3 adresy IP. Jeśli chcesz dodać więcej, będziesz musiał usunąć istniejące.

Korzystanie z API Client LWS

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

Wybierz kategorię oraz polecenie z menu po lewej stronie, aby uzyskać więcej informacji na ich temat. Każda strona składa się z kilku części; górna część strony zawiera podsumowanie akcji oraz adres URL używany dla tego polecenia:

Jeśli polecenie wymaga dodatkowego parametru, zostanie on wskazany poniżej, w sekcji „Request”. W naszym przykładzie polecenie oczekuje nazwy domeny w „PATH”, czyli adresu URL polecenia (w miejscu :domain) :

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

Wszystkie polecenia zwrócą wiadomość po wykonaniu. Może to być komunikat o błędzie, potwierdzenie albo żądane dane (w naszym przykładzie informacje o domenie). Wszystkie możliwe odpowiedzi dla danego polecenia znajdziesz w sekcji „Responses” na stronie:

Dla zaawansowanego użytkownika to wszystko, czego potrzebuje, aby wygodnie korzystać z API. Jednak aby zaoferować API możliwie 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:

Jest to przykład polecenia cURL, które należy wykonać w Terminalu. Pola X-Auth-Login i X-Auth-Path należy wypełnić odpowiednio swoim ID LWS oraz kluczem API, uzyskanym wcześniej.

Pole X-Test-Mode jest opcjonalne i można je usunąć, jeśli jest niepotrzebne. Jeśli ustawione na „true”, pozwala uruchomić polecenie w środowisku testowym bez wykonywania działań na Twoim koncie. Może to być przydatne, aby zobaczyć, jak działa API, bez dokonywania zmian na koncie. Jeśli zdecydujesz się korzystać z trybu testowego, w polu X-Auth-Pass należy wpisać testowe API.

Na koniec możesz korzystać z API bezpośrednio z dokumentacji:

Aby to zrobić, wpisz odpowiednio swoje ID LWS i klucz API w polach ApiAuthID oraz ApiPasswordKey, a także wszystkie parametry wymagane przez polecenie, a następnie kliknij „SEND API REQUEST”. Aby wykonać polecenie w środowisku testowym, wpisz „true” w polu TestMode.

Poniżej otrzymasz wtedy wynik wykonanego polecenia:

Płatne polecenia

Choć większość poleceń jest bezpłatna, niektóre polecenia API nie będą działać bez środków przedpłaconych na koncie. Zakup domeny, odnowienie hostingu, zmiana pakietu, ... Gdy tylko operacja wymaga płatności, zostanie pobrana odpowiednia kwota z Twojego kredytu przedpłaconego LWS (wyłącznie w przypadku powodzenia operacji). Po wykonaniu polecenia nie ma możliwości cofnięcia. Upewnij się, że wiesz, co robisz, zanim skorzystasz z płatnych poleceń.

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

Podsumowanie

Teraz już wiesz, jak:

• Uzyskać klucz API i skonfigurować dozwolone adresy IP, aby zabezpieczyć dostęp do API Client LWS.
• Korzystać z API do zarządzania swoimi usługami w LWS, w tym zakupem hostingu, zmianą DNS i wieloma innymi operacjami.
• Przeglądać oficjalną dokumentację, aby poznać wszystkie dostępne polecenia i ich specyfikę.
• Uruchamiać przykłady użycia API w różnych językach programowania, takich jak PHP.
• Używać API w trybie testowym, aby eksperymentować bez wpływu na konto.
• Zrozumieć, że niektóre polecenia są płatne i wymagają wystarczającego salda przedpłaconego na koncie.

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

Dziękujemy za przeczytanie! Jeśli masz pytania lub chcesz podzielić się swoim doświadczeniem z API Client LWS, zostaw komentarz. Twoja opinia jest cenna dla nas i dla społeczności. 🤝📢