Domein API Handleiding

Transcriptie

1 Domein API Handleiding Versie 1.6 Datum:

2 1 Inhouds opgave 2 Inleiding 3 Result codes 4 Api functies 5 Api helpers 2 Inleiding: De API van 123 Hosting Service kan worden gebruikt om te registreren / te verhuizen en beheren van uw domeinnamen. Deze API kan worden gebruikt op uw eigen website en maakt gebruik van de programmeertaal PHP. Lees deze handleiding zorgvuldig door om fouten te voorkomen. Voor deze handleiding moet je PHP kennis hebben om de functies van de scripts te begrijpen. Voor ondersteuning kunt u zich wenden tot [email protected] De api class is gecodeerd met ioncube, om gebruik te kunnen maken van de api moet u de ioncube loaders op uw server geïnstalleerd hebben voor meer informatie kijkt u op voor downloaden van de ioncube loaders kijkt u op Mocht u zelf geen aanpassingen kunnen doen aan de php.ini op uw server / hosting account maart wel gebruik kunt maken van.htaccess dan kunt u het volgende doen: 1. Upload de ioncube loaders behoorend bij uw php en os versie naar de top map van uw domein (bv www of public_html) 2. Maak of bewerk de.htaccess file 3. Maak of voeg de volgende lijn toe php_value zend_extension <path>/ioncube_loader_lin_4.3.so Note: vervang <path> voor het volledige path waar de loaders in geplaatst en vervang 4.3 voor de loader versie voor uw systeem. Mocht dit ook niet mogelijk zijn vraag u dan uw servr administrator om de ioncube loaders toe te voegen aan de php.ini.

3 Voorbeeld: <?php require("123hostingservice.api.class.php"); $user $pass $hash = "user"; = "password"; = "hashcode"; $Api123 Api123HostingService(); $Api123->setTestModus = true; $Api123->setLogin($user,$pass,$hash); $domain = "domain.com"; $Api123->getListDomain($domain); echo "<pre>"; var_dump($api123->getresult); echo "</pre>";?> Uitleg: $Api123 Api123HostingService(); $Api123->setTestModus = true; $Api123->setLogin($user,$pass,$hash); $Api123->getListDomain($domain); $Api123->getResult Start een nieuw instance Met settestmodus = true worden de gegevens niet actief door gevoerd naar de live database. Gebruik settestmodus = false om de api live te gebruiken. Stel de login gegevens in. Voorbeeld van het commando dat gebruikt kan worden. Dit voorbeeld is om alle uw domeinen te tonen. Dit toont de resultaten van het uitgevoerde commando.

4 3 Result codes Succesvol uitgevoerde opdrachten zal resulteren in een terugkeer 200. Een permanente fout zal resulteren in een terugkeer code 100. Zie voorbeelden van een succesvolle actie en een actie met een fout: Succesvol: array(4) { ["DATA"]=> array(2) { ["DOMAIN"]=> array(1) { [0]=> array(1) { ["DOMAIN"]=> string(13) "testdomain.nl" ["INFORMATION"]=> array(1) { [0]=> array(5) { ["nameservers"]=> array(2) { [0]=> string(24) "ns1.123hostingservice.nl" [1]=> string(24) "ns2.123hostingservice.com" [2]=> string(24) "ns3.123hostingservice.eu" ["handles"]=> array(3) { ["owner"]=> string(7) "handle1" ["admin"]=> string(7) "handle2" ["tech"]=> string(7) "handle3" ["expires"]=> string(10) " " ["regdate"]=> string(10) " " ["authkey"]=> string(13) "Test auth key"

5 ["TESTMODUS"]=> string(4) "true" ["SUCCESCODE"]=> string(3) "200" ["DESCRIPTION"]=> string(30) "Command completed succesfully." Result met fout: array(3) { ["DATA"]=> array(1) { [0]=> array(2) { ["ERRORCODE"]=> string(3) "107" ["ERRORMSG"]=> string(35) "Geen of foutive hash code gevonden." ["SUCCESCODE"]=> string(3) "100" ["DESCRIPTION"]=> string(29) "Command aborted with error's." Een overzicht van alle fout code kan opgevraagt worden met commando: <?php require("123hostingservice.api.class.php"); $user $pass $hash = "user"; = "password"; = "hashcode"; $Api123 Api123HostingService(); $Api123->setTestModus = false; $Api123->setLogin($user,$pass,$hash); $Api123->getErrorMessages(); echo "<pre>"; var_dump($api123->getresult); echo "</pre>";

6 ?> 4 Api functies Functie setlogin() getdomainavailability() getregisterdomain() gettransferdomain() getupdatenameservers() gettoken() getdomainupdate() getlock() getlistdomain() getrenewalmode() getlistevent() getpricelist() getlisthandle() getsearchhandle() getcreatehandle() getupdatehandle() getupdatedomainhandles() getcountryarray() geterrormessages() getspeedregisterdomain() getspeedregisterdomaincheck() getspeedregisterdomainlist() getspeedregisterdomainupdate() getspeedregisterdomainrevoke() getlog() getdeletehandle() Beschrijving Stel de login gegevens in voor verbinding met de api. Controleert of een domeinnaam vrij of bezet is. Registreer domeinnaam Verhuis domeinnaam. Update nameservers. Vraag auth/token code op. Update domein gegevens bij registrar. Zet domein lock aan of uit. List alle domeinnamen. Opzeggen domeinnamen. List uitgevoerde acties van domeinnaam (vanuit registrar) List tld prijzen. List alle handles. Zoek handle. Aanmaken handle. Update handle gegevens. Update handles bij domeinnaam. (Nodig indien houder gegevens wijzigen) List land codes voor gebruik api. (Enkel deze codes worden geaccepteerd door de api) List error berichten. Functie om domeinnamen die in quarantaine of redemption staan te registreren wanneer deze vrij komen Controleer de status van een domeinnaam die pending is voor speedreg List domein data van een domeinnaam die pending is voor speedreg Update de datum van vrij komen van een domeinnaam die pending is voor speedreg Annuleren van speedreg domeinnaam voor dat deze vrij is gekomen (minimaal 24 uur voor dat de naam vrij komt ivm verwerking) Op vragen van domein api log regels Verwijder een handle / contact

7 4 Api helpers Wij hebben een extra file toe gevoegd genaamd apihelpers.php hier in staan een aantal help functies die hier onder verder worden beschreven. Om gebruik te maken van deze functies include u deze file in een script met include() of require() Functie ApiMysql2Date( ); ApiMysql2DateTime( :00:00 ); ApiDate2Mysql( ); Api_is_time( 00:00:00 ); ApiformatTime( 00:00:00, format ); Beschrijving Functie om een datum veld vanaf format yyyy-mm-dd om te zetten naar dd-mm-yyyy format Functie om een datum tijd veld vanaf format yyyy-mm-dd 00:00:00 om te zetten naar dd-mm-yyyy 00:00:00 format Functie om een datum veld format dd-mm-yyyy om te zetten naar format yyyy-mm-dd Functie om te controleren of een value een tijd value is of niet Functie om een tijd value te splitten en en bepaalde value bv alleen de minuten of alleen het uur value te verkrijgen. Format mogelijkheden: 1 hour only 2 minut only 3 seconds only 4 hour, minutes, seconds 5 hour, minutes 6 minutes, seconds Voor alle functies zijn er test scripts toegevoegd aan de zip file. Mocht u enige vragen hebben of problemen ondervinden neemt u dan contact op met D Baars op [email protected]

8 Ook feature aanvragen zijn van harte welkom t.a.v. D Baars [email protected]