KAS API Dokumentation

Vorwort / Allgemeines

Die KAS API bietet eine Schnittstelle zum automatischen Verwalten von KAS-Objekten. So können Sie z.B. das Passwort einer vorhandenen Datenbank ändern oder eine neue Subdomain anlegen. Das Ansteuern der KAS-Schnittstelle funktioniert dabei grundlegend über HTTP- oder HTTPS-Aufrufe.

WICHTIG: Die ersten drei Parameter sind grundlegend die Zugangsdaten des betreffenden KAS-Accounts sowie die Art der Authentifizierung, z.B.:

kas_login=w0213456
kas_auth_data=myPassword
kas_auth_type=plain

In diesem Beispiel authentifizieren Sie sich mit Account "w0213456" sowie dem KAS-Passwort "myPassword" im Klartext (daher "plain"). Als einfachen Start empfehlen wir das Testformular mit Ihren Daten zu versehen. Ergänzen Sie dort neben den 3 o.g. Parametern die gewünschte KAS-Aktion "kas_action", z.B. "get_domains" sowie der Einfachkeit halber im Formular das KAS-Passwort im Klartext. Das Script führt die Abfrage aus und zeigt Ihnen beispielhaft das Ergebnis an. Fertige Beispiele finden Sie hier.

Fehler werden als SoapExceptions bekannt gegeben und können entsprechend behandelt werden. Sollten keine auftreten, so erhalten Sie ein einfaches TRUE als Antwort, dass die Änderung stattgefunden hat. Beachten Sie dazu bitte zusätzlich die jeweiligen Rückgabebeschreibungen der Funktionen in dieser Dokumentation. Die meisten Rückgabewerte sind selbsterklärend, in dieser Dokumentation finden Sie alle Rückgabewerte die Sie erhalten können.

Beachten Sie, dass das KAS einer ständigen Weiterentwicklung unterliegt und sich verschiedene Optionen ändern, gelöscht bzw. hinzugefügt werden können.

Authentifizierung

Die KAS API bietet folgende Möglichkeiten sich via "kas_auth_type" am System zu authentifizieren:

plain - Passwort im Klartext
session - eine gültiger Session-Token

IDN Domains

Bei der KAS-Schnittstelle sollten Sie bei IDN-Domains, immer den Punycode der Domain verwenden. Beachten Sie, dass nicht alle Programme zu 100% mit einer IDN-Domain umgehen können. Die Browser und E-Mail-Clients der aktuellen Generation unterstützen IDN-Domains, jedoch bei älteren Modellen gibt es keine bis wenige, die mit den IDN-Domains zurecht kommen.

Unter phpclasses.org finden Sie PHP-Klassen, die Sie verwenden können, um eine IDN-Domain in Punycode umzuwandeln.

Beispiel:
Der Punycode für die Domain äüö.com lautet: xn—4ca0br.com

Flooding Schutz

Die API wurde mit einem Floodingschutz versehen, um einen möglichen Missbrauch zu verhindern und gleichzeitig eine performante Client Programmierung zu fördern. Die Zeitspanne erhalten Sie bei jeder ausgeführten Aktion als Rückgabewert in "KasFloodDelay". Der Wert beschreibt die Zeitspanne in Sekunden, die gewartet werden sollte, um eine erneute identische Aktion ein weiteres Mal abzusetzen.