Einleitung

Als Reseller der Variomedia AG möchten Sie Domains an Ihre Kunden verkaufen, stehen jedoch vor dem Problem Ihren Kunden eine zuverlässige Abfrage des Domainstatus innerhalb Ihres Bestellsystems zu ermöglichen.
Um Sie von dieser Aufgabe zu befreien haben wir eine Schnittstelle entwickelt, die einfach über CGI nutzbar ist und keine komplexen Protokolle wie z.B. SOAP voraussetzt.
Für diese Schnittstelle stellen wir Ihnen Toolkits für die zwei beliebtesten Programmiersprachen für Webanwendungen bereit: PHP und Perl.

Download

Die Toolkits können Sie hier für die gewünschte Programmiersprache herunterladen. Die Toolkits wurden unter Verwendung grundlegendster Funktionen der jeweiligen Programmiersprachen entwickelt, so dass keine bestimmten Module installieren sein müssen.

Toolkit für PHP

Toolkit für Perl

Installation

Möchten Sie das Toolkit unter Windows entpacken, so benötigen Sie z.B. WinZip, kostenlos als Testversion unter www.winzip.de herunterzuladen. Um die Toolkits unter UNIX-Betriebssystemen wie z.B. Linux zu entpacken, können Sie folgende Kommandos verwenden:

tar xvf toolkit.tar.gz

oder

gzip -d -c toolkit.tar.gz | tar xvf -

Im Toolkit befinden sich folgende Dateien:

PHP-Toolkit	Perl-Toolkit
.htaccess	.htaccess
README	README
domstatus.php	domstatus.pl
vrmd_api.inc	vrmd_api.pm

Die .htaccess benötigen Sie, damit die Datei vrmd_api.inc/vrmd_api.pm nicht von Außenstehenden eingesehen kann, denn dort sind die notwendigen Zugangsdaten für die Benutzung unserer Schnittstelle gespeichert.
README ist ledliglich ein Hinweis auf diese Dokumentation.
domstatus.php/domstatus.pl ist die eigentliche Anwendung für die Abfrage des Domainstatus. Sie sollte einfach in bestehende Anwendungen zu integrieren oder an individuelle Bedürfnisse anzupassen sein.
vrmd_api.inc/vrmd_api.pm ist die Anwendungsbibliothek. Hier sind die Routinen und Funktionen untergebracht die von der eigentlichen Anwendung aus aufgerufen werden.

Installationshinweis: Wir gehen davon aus, dass Ihre Scripte Schreibrechte im aktuellen Verzeichnis haben. Bei der ersten Verwendung werden alle über uns verfügbaren Domainendungen inkl. weiterer Statusinformationen heruntergeladen und in einer Datei gespeichert, damit die Liste bei zukünftigen Aufrufen schneller angezeigt werden kann. Ohne Schreibrechte kann es entweder zu unerwarteten Fehlermeldungen, deutlich verzögertem Seitenaufbau oder beidem kommen. Möchten Sie Domainendungen nicht anbieten, so können Sie die entsprechenden Zeilen einfach aus dieser Datei löschen und die Domainendungen werden Ihren Kunden dann nicht mehr in der Auswahl angeboten. Sollten wir die Verfügbarkeit neuer Domainendungen ankündigen, so löschen Sie einfach die Datei, damit sie beim nächsten Mal mit der vollständigen Liste an Domainendungen aktualisiert wird.

Basis-Konfiguration

Anpassungen vor dem Start

Die Nutzung der API ist nur für bestehende Reseller möglich. Daher müssen Sie Ihre Kundennummer (nicht die Resellerkennung) und das separate API-Passwort (einzustellen im Konfigurationsmenü unter Resellerbereich -> Domainverwaltung -> Einstellungen) in der Funktionsbibliothek angeben.

Angaben für das Perl-Toolkit:
Datei: vrmd_api.pm

$vars{"userid"} = "";
$vars{"password"} = "";

Angaben für das PHP-Toolkit:
Datei: vrmd_api.inc

$vars["userid"] = "";
$vars["password"] = "";

Bitte tragen Sie die entsprechenden Werte zwischen die Hochkommas am Ende der Zeile ein.

Erweiterte Konfiguration

Was geschieht bei Nicht-Erreichbarkeit des Servers?

Ihre Kunden möchten nicht ewig auf den Domainstatus warten. Trotzdem kann es vorkommen, dass eine Domainregistry stark verzögert oder sogar überhaupt nicht antwortet (z.B. bei Wartungsarbeiten). Die Schmerzgrenze können Sie individuell einstellen. Wir haben einen Timeout von 5 Sekunden vorgegeben. Sollte eine Anfrage länger als 5 Sekunden dauern, so wird automatisch der Server als nicht erreichbar betrachtet. Derartige Verzögerungen sollten im Regelfall nur einzelne Domainendungen betreffen. Sofern Sie den Wert verändern möchten können Sie dies durch Anpassung der Variablen $timeout tun. Er sollte er nicht kleiner als 5 Sekunden gewählt werden.

Unicode vs. Latin1 oder
Wichtige Hinweise für Umlautdomains/IDNs

Unicode ist in aller Munde und wird langfristig wohl Latin1 (das Standard-Characterset im europäischen Sprachraum) sowie viele spezialisierte Charactersets wie z.B. das für griechische Buchstaben ablösen. Während in Latin1, auch unter ISO-8859-1 bekannt, zum Character-Encoding maximal 256 Zeichen (d.h. genau 1 Byte) zur Verfügung stehen, so sind in Unicode (geläufigster Vertreter ist UTF-8) auch multibyte-characters möglich. So lassen sich mehrere tausend Zeichen darstellen, wie das z.B. im Chinesischen oder Japanischen unbedingt nötig ist.

- Was hat das nun mit unserer Schnittstelle zu tun? -

Seit einiger Zeit sind Domains mit Umlauten möglich, wie z.B. müller.com oder mädchen.de. Diese Umlaute müssen kodiert werden. Diese Arbeit übernimmt der Browser für Sie, jedoch unter Verwendung eines bestimmten Character-Encodings. Da sich auf der Seite unserer Schnittstelle nicht herausfinden läßt welches Character-Encoding verwendet wurde, muß dieses explizit übergeben werden. Der Standard in unseren Toolkits ist UTF- 8. Sollte Ihre Webseite mit ISO-8859-1 arbeiten, so müssen Sie den Funktionsaufruf getDomainStatus() in domstatus.php/domstatus.pl um einen dritten Parameter ergänzen, nämlich so:

PHP:

$status = getDomainStatus($_REQUEST["sld"], $_REQUEST["tld"], "no");

Perl:

$status = getDomainStatus($Q::sld, $Q::tld, "no");

Umlaut-Domains/IDNs und Punycode

Unsere Schnittstelle können Sie natürlich auch dafür verwenden, um aus Domainnamen mit Umlauten wie z.B. müller.com den entsprechenden Punycode heraus zu bekommen, in diesem Fall xn--mller-kva.com. Der Punycode steht nach dem Aufruf von getDomainStatus in

PHP:	$status["domain-ace"]
Perl:	$status{"domain-ace"}

Hilfe

Sollten Fragen in dieser kurzen Dokumentation unbeantwo rtet geblieben sein, oder haben Sie andere Probleme bei der Einbindung der Toolkits in Ihre Anwendungen, so wenden Sie sich bitte an unseren Support.