Wie verwende und konfiguriere ich die LWS Client API?

Procédure

Die LWS Client API ist ein Gateway, das die Integration mit den von LWS (Ligne Web Services) angebotenen Diensten und Produkten erleichtern soll. Mithilfe dieser API können Nutzer ihre Dienste effizient bestellen und verwalten, z. B. Hosting kaufen, DNS ändern und vieles mehr.

In dieser Dokumentation führen wir Sie durch die notwendigen Schritte, um Ihren API-Schlüssel zu erhalten und mit der Nutzung der Funktionen des API-Clients zu beginnen. Obwohl es mehr auf Entwickler ausgerichtet ist, kann es auch ein Neuling verwenden.

Sich bei der API authentifizieren.

Generieren Sie den API-Schlüssel.

Um den missbräuchlichen Zugriff auf die API zu verhindern, müssen Sie einen API-Schlüssel erhalten, der mit Ihrem LWS-Konto verknüpft ist, sowie eine oder mehrere IPs festlegen, die die API nutzen dürfen. Sie müssen ein LWS-Konto besitzen, um die API nutzen zu können. Wenn Sie noch kein API besitzen, können Sie sich auf der offiziellen LWS-Website als neuer Kunde registrieren.

Um Ihren API-Schlüssel zu erhalten, loggen Sie sich über das LWS-Panel in Ihr Konto ein und gehen Sie auf die Seite "Kontaktdaten".

Hier klicken Sie auf den Reiter "LWS API", um auf die Seite zur Verwaltung des API-Zugangs zu gelangen.

Auf dieser Seite sehen Sie alle IPs, die mit Ihren Zugangsdaten die API nutzen dürfen, sowie den Saldo Ihres Prepaid-Kontos, der verwendet werden kann, um Ihre über die API erworbenen Domains und Hostings zu kaufen oder zu verlängern. Um Ihren API-Schlüssel zu generieren, klicken Sie auf die Schaltfläche "Ansehen" vor der Option "API-Schlüssel im PRODUKTIONSMODUS", um eine Modalität zu öffnen, mit der Sie Ihren API-Schlüssel generieren können.

Klicken Sie hier auf die Schaltfläche, um den Schlüssel zu generieren. Bewahren Sie ihn gut auf, damit Sie ihn nicht verlieren. Wenn Sie einen neuen Schlüssel generieren möchten, gehen Sie zu dieser Modalität zurück und klicken Sie erneut auf die Schaltfläche.

Mit diesem Schlüssel können Sie die gesamte API in ihrem normalen Modus verwenden. Wenn Sie die API in einer isolierten Umgebung zu Testzwecken verwenden möchten, benötigen Sie einen Schlüssel für den TEST-Modus, den Sie auf die gleiche Weise wie die Schlüssel für den Produktionsmodus erstellen können, indem Sie einfach neben der Zeile "API-Schlüssel für den TEST-Modus" auf "Sehen" klicken. Es ist nicht möglich, den Testschlüssel in der Produktion zu verwenden und umgekehrt.

Den Zugriff auf eine IP erlauben

Der zweite Schritt, um die LWS-API nutzen zu können, besteht darin, einer oder mehreren IPs die Nutzung der API zu erlauben. Dies ist eine zusätzliche Schutzmethode, damit jemand, der Ihren Schlüssel in die Finger bekommen hat, keine unerwünschten Bestellungen tätigen kann, wie z. B. Domains für Sie zu kaufen.

Dies geschieht an derselben Stelle wie beim API-Schlüssel; dieses Mal klicken Sie auf die Schaltfläche "IP-Adresse hinzufügen", um das Fenster zum Hinzufügen von IPs zu öffnen.

In diesem Fenster wählen Sie "Produktion" und geben dann Ihre IP-Adresse ein. Wenn Sie diese nicht kennen, können Sie eine Website verwenden, um Ihre aktuelle IP zu erhalten. Je nach Netzwerk, mit dem Sie verbunden sind, kann Ihre IP unterschiedlich sein, sodass Sie möglicherweise mehrere IPs angeben müssen, um die API überall nutzen zu können. Wenn Sie die IP hinzufügen möchten, um sie im Testmodus zu verwenden, wählen Sie stattdessen "Test".

Sobald Sie dies bestätigt haben, können Sie die IPs, die derzeit die API nutzen dürfen, in einer Tabelle auf der Seite einsehen und löschen. Für jeden Modus können bis zu drei IPs hinzugefügt werden. Wenn Sie weitere hinzufügen möchten, müssen Sie diese löschen.

Die LWS Client API verwenden.

Sie können die offizielle Dokumentation mit einer Liste aller verfügbaren Befehle und Anwendungsbeispiele finden, um herauszufinden, wie Sie unsere API nutzen können.

Wählen Sie eine Kategorie sowie einen Befehl aus dem Menü auf der linken Seite aus, um mehr Informationen über diese zu erhalten. Jede Seite besteht aus mehreren Teilen; Der obere Teil der Seite enthält eine Zusammenfassung der Aktion sowie die URL, die für diesen Befehl verwendet werden soll :

Für den Fall, dass der Befehl einen zusätzlichen Parameter erfordert, wird dieser unten im Abschnitt "Request" angegeben. In unserem Beispiel erwartet der Befehl einen Domainnamen im "PATH", die URL des Befehls (anstelle von :domain) :

Für den Fall, dass weitere Parameter benötigt werden, insbesondere im Körper der Anfrage, werden diese ebenfalls in der Kategorie "body" angegeben.

Alle Befehle geben nach ihrer Ausführung eine Meldung zurück. Dies kann eine Fehlermeldung, eine Bestätigungsmeldung oder auch die angeforderten Daten (in unserem Beispiel die Informationen über die Domain) sein. Alle möglichen Rückmeldungen eines bestimmten Befehls finden Sie im Abschnitt "Responses" auf der Seite :

Für einen fortgeschrittenen Nutzer sind diese Informationen alles, was er braucht, um die API komfortabel zu nutzen. Um die API jedoch so vielen Menschen wie möglich zur Verfügung zu stellen, egal ob Anfänger oder Experte, gibt es Anwendungsbeispiele in verschiedenen Programmiersprachen, wie z. B. PHP :

Hier handelt es sich um ein Beispiel für einen cURL-Befehl, der im Terminal ausgeführt werden soll. Die Felder X-Auth-Login und X-Auth-Path sind mit Ihrer LWS-ID bzw. Ihrem API-Schlüssel auszufüllen, den Sie zuvor erhalten haben.

Das Feld X-Test-Mode ist optional und kann entfernt werden, wenn es nicht benötigt wird. Wenn es auf "true" gesetzt ist, ermöglicht es, den Befehl in einer Testumgebung auszuführen, ohne Aktionen auf Ihrem Konto durchzuführen. Dies kann nützlich sein, um zu sehen, wie die API funktioniert, ohne Manipulationen an Ihrem Konto vorzunehmen. Sie müssen eine Test-API in das Feld X-Auth-Pass eingeben, wenn Sie sich für den Testmodus entscheiden.

Schließlich können Sie die API auch direkt aus der Dokumentation heraus verwenden:

Geben Sie dazu Ihre LWS-ID und Ihren API-Schlüssel in die Felder ApiAuthID und ApiPasswordKey ein, sowie alle für den Befehl erforderlichen Parameter, und klicken Sie auf "SEND API REQUEST". Um den Befehl in der Testumgebung auszuführen, geben Sie im Feld "TestMode" den Wert "true" ein.

Sie sehen dann unten die Rückmeldung des ausgeführten Befehls:

Kostenpflichtige Befehle

Obwohl die meisten Befehle kostenlos sind, werden einige API-Befehle ohne vorausbezahltes Guthaben auf dem Konto nicht funktionieren. Der Kauf einer Domain, die Verlängerung eines Hostings, die Änderung eines Pakets, ... Sobald die Aktion eine Zahlung erfordert, wird Ihnen der entsprechende Betrag von Ihrem LWS-Prepaid-Guthaben abgebucht (nur bei erfolgreicher Aktion). Nach Abschluss der Bestellung ist kein Rückgängigmachen mehr möglich. Stellen Sie sicher, dass Sie wissen, was Sie tun, bevor Sie kostenpflichtige Aufträge nutzen.

Das Prepaid-Konto ist derzeit die einzige Zahlungsmethode, die von der API akzeptiert wird. Wenn Sie nicht genügend Guthaben auf Ihrem Konto haben, können Sie es auf der dafür vorgesehenen Seite aufladen.

Schlussfolgerung

Sie wissen nun, wie Sie :

• Ihren API-Schlüssel erhalten und die autorisierten IPs konfigurieren, um den Zugriff auf dieLWS Client API zu sichern.
• DieAPI verwenden, um Ihre Dienste bei LWS zu verwalten, einschließlich des Kaufs von Hosting, der Änderung von DNS und vielem mehr.
• Erkunden Sie die offizielle Dokumentation, um alle verfügbaren Befehle und ihre Besonderheiten zu entdecken.
• Führen Sie Beispiele für die Verwendung der API in verschiedenen Programmiersprachen, wie z. B. PHP, aus.
• Die API im Testmodus verwenden, um zu experimentieren, ohne Ihr Konto zu beeinträchtigen.
• Verstehen, dass einige Bestellungen kostenpflichtig sind und ein ausreichendes Prepaid-Guthaben auf Ihrem Konto erfordern.

Mit diesen Informationen sind Sie gewappnet, um die Möglichkeiten derLWS Client API voll auszuschöpfen und Ihre Online-Dienste optimal zu verwalten. 🚀💻

Vielen Dank, dass Sie unsere Seite gelesen haben! Wenn Sie Fragen haben oder Ihre Erfahrungen mit der LWS Client API teilen möchten, hinterlassen Sie bitte einen Kommentar. Ihr Feedback ist wertvoll für uns und die Community. 🤝📢