De même nous vous invitons vivement à archiver toute trace des échanges réalisés via l'API.

Variables fournies à l'API dans les exemples de ce document:

    $dist_id    =   login du partenaire
 
    $dist_passwd =  mot de passe du partenaire
 
    $domain = un nom de domaine (en .com .net .org .biz .info .name .eu .be .us .fr .cn .tw .asia, etc.)
 
    $period = un nombre d annee (de 1 a 10)
 
    $id     = un contact ID
 
    $handle = un handle de contact
 
    $tid    = un transaction ID (pour connaitre le status d une action)
              'status' possible = enum('Wait','ToProcess','Done','Error')
 
    $array_domain = array(
        "domain"   => $domain,  // nom de domaine
        "period"   => 1,        // enregistrement pour 1 an
        "owner_id" => $id,      // contact ID 
        "admin_id" => $dist_id, // Contact Admin = partenaire?
        "tech_id"  => $dist_id, // Contact Technique = partenaire?
        "bill_id"  => $dist_id, // Contact Facturation = partenaire?
        "service"  => "dns",    // enum('parking','redir','dns','dnsslave','dnsperso')
	"langidn"  => "FRE",	// tag Verisign pour les IDN (voir la liste en fin de page)
        "ip_dns_master"  => "", // si dnsslave => fournir l'IP du master
        "ns0"  => "nsa.bookmyname.com", // jusqu'a 13 DNS pour un update
        "ns1"  => "nsb.bookmyname.com"  // ou maxi 4 pour une creation
        "ns2"  => "nsc.bookmyname.com"  // 
        "ipns0"  => "",
        "ipns1"  => "",
        "ipns2"  => "62.210.98.15", // glue record (si besoin) voir aussi les fonctions host_()
 
        // les champs suivant sont uniquement utilisés par domain_update();
        "registry_status" => 0,     // Exemple: 64=clientTransferProhibited
        "authinfo" => "EPPauthCode" // Changement de l'AuthCode EPP
        );
 
    $array_contact = (
        "passwd" => "tres-secret",
        "email" => "dupond@free.fr",
        "formejuridique" => "particulier",  // enum('Particulier','Societe','Association','Autre')
        "civilite" => "M",                  // enum('','M','Mme','Mle')
        "nom" => "DUPOND",
        "prenom" => "Pierre",
        "societe" => "",
        "adresse1" => "12 Rue du chien qui fume",
        "adresse2" => "",
        "cp" => "75001",
        "ville" => "PARIS",
        "region_id" => "",                  // voir api_regionsid()
        "pays_id" => "1",                   // voir api_paysid()
        "telephone" => "+33.147010203",
        "telecopie" => "",
        "numero_tva" => "",
        "siret" => "",
        "lang" => "fr",                     // fr en de es
 
        // Notre contrat avec l'ICANN nous oblige à revendre notre base d'utilisateurs à tout tiers qui le souhaite.
        // Mais vous avez le droit de ne pas accepter que vos données fassent partie du lot.
        // Definir 'yes' uniquement si vous acceptez que vos données personnelles soient revendues dans ce cadre
        "revente" => "no",                  // yes no
 
        // NEXUS (utile uniquement pour le ccTLD .US)
 
        "dotus_nexus_purpose" => "",
            // Purpose
            // P1 Business
            // P2 Non-Profit Business
            // P3 Personal Use
            // P4 Education
            // P5 Goverment
 
        "dotus_nexus_category" => "",
            // Category
            // C11 U.S. Citizen
            // C12 U.S. Permanent Resident
            // C21 U.S. Organization Incorprated in U.S.
            // C31 Non-US: Regularly engages in lawful activities in U.S.
            // C32 Non-US: Entity has an office or other facility in U.S.
 
	// Extensions (utile uniquement pour le ccTLD .FR)
 
	// Choix de la methode d'authentification par l'AFNIC
	// ATTENTION il doit y avoir une coherence entre la forme juridique 
	// et le mode d'authentification de l'AFNIC
 
        "dotfr_mode" => "",         // enum('MARQUE','SIRET','PARTICULIER','ASSOCIATION','DUNS','LOCAL')
 
        "dotfr_marque" => "",       // une marque de l'INPI
 
	// pour une société hors de France mais domicilié dans un pays membres de l'union européenne
        "dotfr_duns" => "",         // http://en.wikipedia.org/wiki/Data_Universal_Numbering_System
        "dotfr_local" => "",        // un identifiant local au pays (équivalent SIRET)
 
	// pour un particulier
        "dotfr_restricted_publication" => "yes",   // yes = whois anonyme, no = information visible
 
	// pour une association loi 1901
        "dotfr_publication_jo" => "", // date de publication au journal officiel sous la forme: (JJ-MM-AAAA)
        "dotfr_publication_jo_page" => "", // numero de page de la publication au journal officiel
 
	// Extensions (utile uniquement pour le gTLD .ASIA)
        "asia_locality" => "",        // un pays_id de la zone Asie,Australie,Pacifique
        "asia_typeofentity" => "",    // enum('naturalPerson','corporation','cooperative','partnership','government','politicalParty','society','institution')
        "asia_formofident" => "",     // enum('passport','certificate','legislation','societyRegistry','politicalPartyRegistry')
        "asia_identnumber" => "",     // 
 
	// Extensions (utile uniquement pour le ccTLD .UK)
        "dotuk_mode" => "",           // Registrant types. http://www.nominet.org.uk/registrars/systems/data/regtype/
                                      // enum('LTD','PLC','IND','FIND','RCHAR','SCH','LLP','STRA','PTNR','GOV','CRC','STAT','FCORP','IP','OTHER','FOTHER')
        "dotuk_locality" => "",
        "dotuk_county" => "",
        "dotuk_trad_name" => "",
        "dotuk_co_number" => "",
 
	// Extensions (utile uniquement pour le ccTLD .IT)
 
            // En fonction du titulaire:
            // . Particulier Italien => Codice Fiscale (16 characteres).
            // . Particulier qui n'est pas Italien => Numéro de passport.
            // . Associations numero de TVA => "Pin" = "n.a."
            // . Dans tout les autres cas, le "Pin" doit être un numéro de TVA intracommunautaire
 
        "dotit_pin" => "",
 
	// Extensions (utile uniquement pour le ccTLD .EU)
 
            // Si le titulaire est de type 'Particulier' definir le pays_id de citoyenneté (En Europe).
            // 1,1,11,12,13,15,31,49,70,72,73,74,83,88,89,97,100,111,117,132,138,139,147,149,185,186,189,190,207,208,213,219
 
        "doteu_countryofcityzenship" => "",
 
	// Extensions (utile uniquement pour le ccTLD .NU)
 
            // . Particulier => Numéro de passport ou carte d'identité.
            // . Société => numéro de TVA intracommunautaire
 
        "dotnu_idno" => "",
 
        // Extensions (utile uniquement pour le ccTLD .ES)
 
            // contact espagnol => DNI/NIF (Numero d'identification fiscale).
            // contact étranger vivant en espagne => NIE (numéro d'identification des étrangers en Espagne).
            // contact hors d'espagne dans l'UE => (numéro de passport).
 
        "dotes_pin" => "",
 
        // Extensions (utile uniquement pour le .XXX
 
        "dotxxx_membership" => "",
 
        // Extensions (utile uniquement pour le .NL
 
           // valeurs possible pour dotnl_legalform:
           // ANDERS      Other
           // BGG         Non-Dutch EC company (Societe europeen en dehors des pays-bas).
           // BRO         Non-Dutch legal form/enterprise/subsidiary
           // BV          Limited company
           // BVI/O       Limited company in formation
           // COOP        Cooperative
           // CV          Limited Partnership
           // EENMANSZAAK Sole trader
           // EESV        European Economic Interest Group
           // KERK        Religious society
           // MAATSCHAP   Partnership
           // NV          Public Company
           // OWM         Mutual benefit company
           // PERSOON     Natural person (Particulier)
           // REDR        Shipping company
           // STICHTING   Foundation
           // VERENIGING  Association
           // VOF         Trading partnership
 
        "dotnl_legalform" => "",
 
           // Registration number of company or empty
 
        "dotnl_legalformregno" = > "",
 
        // Extensions (Uniregistry, pour les nTLDs d'Uniregistry)
 
        "dotu_emailalt"  => "ma.2ieme.adresse.email@free.fr", // facultative
        "dotu_mobile"    => "+33.612345678",                  // facultative
        "dotu_question1" => "question secrete1",              // obligatoire
        "dotu_answer1"   => "reponse secrete1",               // obligatoire
        "dotu_question2" => "question secrete2",              // obligatoire
        "dotu_answer2"   => "reponse secrete2",               // obligatoire
        "dotu_question3" => "question secrete3",              // obligatoire
        "dotu_answer3"   => "reponse secrete3",               // obligatoire
        "dotu_question4" => "question secrete4",              // facultative
        "dotu_answer4"   => "reponse secrete4",               // facultative
        "dotu_question5" => "question secrete5",              // facultative
        "dotu_answer5"   => "reponse secrete6",               // facultative
 
        );

Avant toute opération vous devez construire un objet SoapClient

Exemple PHP 5.1:

    $client = new SoapClient( NULL,
        array(  'location' => "http://api.dev.bookmyname.com/apis.cgi",
                'uri' => "http://api.dev.bookmyname.com/apis.cgi",
                'encoding'=>'UTF-8'
                )
            );

Exemple Perl:

    use SOAP::Lite;
 
    my $client = SOAP::Lite
        -> uri('http://api.dev.bookmyname.com/apis.cgi')
        -> proxy('http://api.dev.bookmyname.com/apis.cgi');

Gestion des contacts

• contact_create

Typage:

function contact_create( $dist_id, $dist_passwd, $array_contact )

Valeurs de retour:

[retcode] => 1
[retval] => 151049
[retfields] => Array
    (
        [id] => 151049
        [parent_id] => 13490
        [lastupdate] => 2006-09-26 21:42:59
        [lastupdate_ip] => 88.191.249.162
        [handle] => PD86-FREE
        [creation] => 2006-09-26 21:42:59
        [email] => dupond@free.fr
        [md5_email] => eb94fe20.151049@contacts.nospam.free.org
        [formejuridique] => Particulier
        [civilite] => M
        [nom] => DUPOND
        [prenom] => Pierre
        [societe] => 
        [adresse1] => 12 Rue du chien qui fume
        [adresse2] => 
        [cp] => 75001
        [ville] => PARIS
        [pays_id] => 1
        [telephone] => +33.147010203
        [telecopie] => 
        [numero_tva] => 
        [siret] => 
        [lang] => fr
        [revente] => no
        [status] => Active
        [pays] => FRANCE
    )

Exemple PHP:

    /* Création d'un contact --------------------------------------------- */
 
    $newcontact = array (
        "passwd" => "coincoin",
        "email" => "dupond@free.fr",
        // enum('Particulier','Societe','Association','Autre') 
        "formejuridique" => "particulier",
        // enum('','M','Mme','Mle')
        "civilite" => "M",
        "nom" => "DUPOND",
        "prenom" => "Pierre",
        "societe" => "",
        "adresse1" => "12 Rue du chien qui fume",
        "adresse2" => "",
        "cp" => "75001",
        "ville" => "PARIS",
        // voir api_regionsid()
        "region_id" => "",
        // voir api_paysid()
        "pays_id" => "1",
        "telephone" => "+33.147010203",
        "telecopie" => "",
        "numero_tva" => "",
        "siret" => "",
        // fr en de es 
        "lang" => "fr",
        // yes/no
        "revente" => "no",
 
        // NEXUS (utile uniquement pour l'enregistrement de .US)
        "dotus_nexus_purpose" => "", 
            // "P1" Business
            // "P2" Non-Profit Business
            // "P3" Personal Use
            // "P4" Education
            // "P5" Goverment
        "dotus_nexus_category" => "",
            // "C11" U.S. Citizen
            // "C12" U.S. Permanent Resident
            // "C21" U.S. Organization Incorprated in U.S.
            // "C31" Non-US: Regularly engages in lawful activities in U.S.
            // "C32" Non-US: Entity has an office or other facility in U.S.
 
	// Extensions (utile uniquement pour lenregistrement de .FR)
 
	// choix de la methode d'authentification par l'AFNIC
        "dotfr_mode" => "",         // enum('MARQUE','SIRET','PARTICULIER','ASSOCIATION')
 
        "dotfr_marque" => "",       // une marque de l'INPI ou OHMI
 
	// pour une association loi 1901
        "dotfr_publication_jo" => "", // date de publication au journal officiel sous la forme: (JJ-MM-AAAA)
        "dotfr_publication_jo_page" => "", // numero de page de la publication au journal officiel
 
	// Extensions (utile uniquement pour le ccTLD .UK)
        "dotuk_mode" => "",           // Registrant types. http://www.nominet.org.uk/registrars/systems/data/regtype/
                                      // enum('LTD','PLC','IND','FIND','RCHAR','SCH','LLP','STRA','PTNR','GOV','CRC','STAT','FCORP','IP','OTHER','FOTHER')
        "dotuk_locality" => "",
        "dotuk_county" => "",
        "dotuk_trad_name" => "",
        "dotuk_co_number" => "",
 
	// Extensions (utile uniquement pour le ccTLD .IT)
 
            // En fonction du titulaire:
            // . Particulier Italien => Codice Fiscale (16 characteres).
            // . Particulier qui n'est pas Italien => Numéro de passport.
            // . Associations numero de TVA => "Pin" = "n.a."
            // . Dans tout les autres cas, le "Pin" doit être un numéro de TVA intracommunautaire
 
        "dotit_pin" => "",
 
	// Extensions (utile uniquement pour le ccTLD .EU)
 
            // Si le titulaire est de type 'Particulier' definir le pays_id de citoyenneté (En Europe).
            // 1,1,11,12,13,15,31,49,70,72,73,74,83,88,89,97,100,111,117,132,138,139,147,149,185,186,189,190,207,208,213,219
 
        "doteu_countryofcityzenship" => "",
 
        // Extensions (utile uniquement pour le ccTLD .ES)
 
            // contact espagnol => DNI/NIF (Numero d'identification fiscale).
            // contact étranger vivant en espagne => NIE (numéro d'identification des étrangers en Espagne).
            // contact hors d'espagne dans l'UE => (numéro de passport).
 
        "dotes_pin" => "",
 
	// Extensions (utile uniquement pour le ccTLD .NU)
 
            // . Particulier => Numéro de passport ou carte d'identité.
            // . Société => numéro de TVA intracommunautaire
 
        "dotnu_idno" => "",
 
        // Extensions (utile uniquement pour le .XXX
 
        "dotxxx_membership" => "",
 
        // Extensions (Uniregistry, pour les nTLDs d'Uniregistry)
 
        "dotu_emailalt"  => "ma.2ieme.adresse.email@free.fr", // facultative
        "dotu_mobile"    => "+33.612345678",                  // facultative
        "dotu_question1" => "question secrete1",              // obligatoire
        "dotu_answer1"   => "reponse secrete1",               // obligatoire
        "dotu_question2" => "question secrete2",              // obligatoire
        "dotu_answer2"   => "reponse secrete2",               // obligatoire
        "dotu_question3" => "question secrete3",              // obligatoire
        "dotu_answer3"   => "reponse secrete3",               // obligatoire
        "dotu_question4" => "question secrete4",              // facultative
        "dotu_answer4"   => "reponse secrete4",               // facultative
        "dotu_question5" => "question secrete5",              // facultative
        "dotu_answer5"   => "reponse secrete6",               // facultative
);
 
    echo "contact_create() \n";
    $result = $client->contact_create( $dist_id, $dist_passwd, $newcontact );
    print_r( $result );
 
    if ( $result['retcode'] != 1 )
        die( "Ca ne fonctionne pas !" );

Exemple Perl:

    # Creation d'un contact
 
    my $contact_id;
 
    my %newcontact = (
	# force type string pour eviter la conversion en float
        'passwd' => SOAP::Data->type(string =>'coincoin'),
        'email' => 'dupond@free.fr',
        # enum('Particulier','Societe','Association','Autre')
        'formejuridique' => 'particulier',
        # enum('','M','Mme','Mle')
        'civilite' => 'M',
        'nom' => 'DUPOND',
        'prenom' => 'Pierre',
        'societe' => '',
        'adresse1' => '12 Rue du chien qui fume',
        'adresse2' => '',
        'cp' => SOAP::Data->type(string =>'75001'),
        'ville' => 'PARIS',
        # voir api_regionsid()
        'region_id' => '',
        # voir api_paysid()
        'pays_id' => '1',
	# force type string pour eviter la conversion en float
        'telephone' => SOAP::Data->type(string =>'+33.147010203'),
        'telecopie' => SOAP::Data->type(string => ''),
        'numero_tva' => '',
        'siret' => SOAP::Data->type(string =>''),
        'lang' => 'fr',
        'revente' => 'no',
 
        # NEXUS (utile uniquement pour l'enregistrement des .US
        'dotus_nexus_purpose' => '',
            # "P1" Business
            # "P2" Non-Profit Business
            # "P3" Personal Use
            # "P4" Education
            # "P5" Goverment
        'dotus_nexus_category' => '',
            # C11" U.S. Citizen
            # "C12" U.S. Permanent Resident
            # "C21" U.S. Organization Incorprated in U.S.
            # "C31" Non-US: Regularly engages in lawful activities in U.S.
            # "C32" Non-US: Entity has an office or other facility in U.S.
    );
 
    print "contact_create\n";
    $result = $client->contact_create( $dist_id, $dist_passwd, SOAP::Data->type(map =>\%newcontact));
 
    if ($result->result->{'retcode'} !=1)
    {
        die "Ca ne fonctionne pas create!\n";
    };
    $contact_id = $result->result->{'retval'};

• contact_update

Typage:

function contact_update( $dist_id, $dist_passwd, $id, $array_contact )

Valeurs de retour:

ATTENTION dans certain cas il n'est pas possible de modifier les informations.

Par exemple dans le cas ou le contact est utilisé comme titulaire d'un nom de domaine

• la forme juridique n'est pas modifiable
• la société n'est pas modifiable
• si particulier la civilité n'est pas modifiable
• si particulier le nom n'est pas modifiable
• si particulier le prénom n'est pas modifiable
• le pays n'est pas modifiable

ou le cas ou le contact est utilisé comme contact de facturation d'un nom de domaine

• le pays n'est pas modifiable

[retcode] => 1
[retval] => 151049
[retfields] => Array
    (
        [id] => 151049
        [parent_id] => 13490
        [lastupdate] => 2006-09-26 21:42:59
        [lastupdate_ip] => 88.191.249.162
        [handle] => PD86-FREE
        [creation] => 2006-09-26 21:42:59
        [email] => dupond@free.fr
        [md5_email] => eb94fe20.151049@contacts.nospam.free.org
        [formejuridique] => Particulier
        [civilite] => M
        [nom] => DUPONT
        [prenom] => Pierre
        [societe] => 
        [adresse1] => 12 Rue du chien qui fume
        [adresse2] => 
        [cp] => 75001
        [ville] => PARIS
        [pays_id] => 1
        [telephone] => +33.147010203
        [telecopie] => +33.173500000
        [numero_tva] => 
        [siret] => 
        [lang] => fr
        [revente] => no
        [whois_pub] => no
        [status] => Active
        [pays] => FRANCE
    )

Exemple PHP:

    /* Update d'un contact ---------------------------------------------- */
 
    // $result = resultat d'un contact_info() 
    $contact_id = $result['retval'];
    $updcontact = $result['retfields'];
    $updcontact['nom'] = "DUPONT";
    $updcontact['telecopie'] = "+33.173500000";
 
    echo "contact_update() \n";
    $result = $client->contact_update( $dist_id, $dist_passwd, 
        $contact_id, $updcontact );
    print_r( $result );
 
    if ( $result['retcode'] != 1 )
        die( "Ca ne fonctionne pas !" );

Exemple Perl:

    # Update d'un contact
 
    $updcontact{'nom'} = 'DUPONT';
    $updcontact{'telecopie'} = SOAP::Data->type(string =>'+33.173500000');
 
    print "contact_update\n";
    $result = $client->contact_update( $dist_id, $dist_passwd, $contact_id,
	SOAP::Data->type(map => \%updcontact ));
    if ($result->result->{'retcode'} !=1)
    {
        die "Ca ne fonctionne pas !\n";
    };

• contact_delete

Typage:

function contact_delete( $dist_id, $dist_passwd, $id )

Valeurs de retour:

Exemple PHP:

    /* Delete d'un contact ---------------------------------------------- */
 
    echo "contact_delete()\n";
    $result = $client->contact_delete( $dist_id, $dist_passwd, $id );
    print_r( $result );
 
    if ( $result['retcode'] != 1 )
        die( "Ca ne fonctionne pas !" );

Exemple Perl:

    # Delete d'un contact
 
    print "contact_delete\n";
    $result = $client->contact_delete( $dist_id, $dist_passwd, $contact_id );
    print Data::Dumper->Dump([$result->result]);

• contact_info

Typage:

function contact_info( $dist_id, $dist_passwd, $handle, $id )

fournir $handle OU ($id avec $handle vide)

Valeurs de retour:

Les valeurs de:

[retcode] => 1
[retval] => 151049
[retfields] => Array
    (
        [id] => 151049
        [parent_id] => 13490
        [lastupdate] => 2006-09-26 21:42:59
        [lastupdate_ip] => 88.191.249.162
        [handle] => PD86-FREE
        [creation] => 2006-09-26 21:42:59
        [email] => dupond@free.fr
        [md5_email] => eb94fe20.151049@contacts.nospam.free.org
        [formejuridique] => Particulier
        [civilite] => M
        [nom] => DUPONT
        [prenom] => Pierre
        [societe] => 
        [adresse1] => 12 Rue du chien qui fume
        [adresse2] => 
        [cp] => 75001
        [ville] => PARIS
        [pays_id] => 1
        [telephone] => +33.147010203
        [telecopie] => +33.173500000
        [numero_tva] => 
        [siret] => 
        [lang] => fr
        [revente] => no
        [whois_pub] => no
        [status] => Active
        [waps_ok] => 1
        [waps_email] => contact@bookmyname.com
        [waps_lastupdate] => 2016-07-07 23:19:20
        [waps_lastvalid] => 2016-07-07 23:19:20
        [waps_lastemail] => 2016-07-05 10:50:57
        [waps_lastvalidkey] => 2016-07-07 23:19:20 - 0123456-qjYD9UfsdasP7TKGwrpy8TQs - 88.191.249.162
    )

Exemple PHP:

    /* Info a propos d'un contact --------------------------------------- */
 
    echo "contact_info()\n";
    $id = 123;
    $result = $client->contact_info( $dist_id, $dist_passwd, "", $id );
    print_r( $result );
 
    echo "contact_info() par handle du type 'QQQ123-FREE'\n";
    $handle = "QQQ123-FREE";
    $result = $client->contact_info( $dist_id, $dist_passwd, $handle );
    print_r( $result );

Exemple Perl:

    # Info a propos d'un contact
 
    print "contact_info id\n";
    $result = $client->contact_info( $dist_id, $dist_passwd, '', $contact_id );
    print Data::Dumper->Dump([$result->result->{'retfields'}]);
 
    if ($result->result->{'retcode'} !=1)
    {
        die "Ca ne fonctionne pas contact_info\n";
    };
    %updcontact = %{$result->result->{'retfields'}};
 
    my $handle = $result->result->{'retfields'}->{'handle'};
 
    print "contact_info handle $handle\n";
 
    $result = $client->contact_info( $dist_id, $dist_passwd, $handle );
    print Data::Dumper->Dump([$result->result->{'retfields'}]);

• contact_list

Typage:

function contact_list( $dist_id, $dist_passwd )

Valeurs de retour:

Exemple PHP:

    /* Liste les contacts cree par le partenaire $dist_id ---------------- */
 
    echo "contact_list()\n";
    $result = $client->contact_list( $dist_id, $dist_passwd );
    print_r( $result );

Exemple Perl:

    # Liste les contacts cree par le partenaire $dist_id
 
    print "contact_list()\n";
    $result = $client->contact_list( $dist_id, $dist_passwd );
    print Data::Dumper->Dump([$result->result->{'retfields'}]);

• check_contact_create_tlds

Controle l'usage d'un contact pour chaque TLDs d'un tableau.

Typage:

function check_contact_create_tlds( $dist_id, $dist_passwd, $newcontact, $atlds );

$dist_id = distributeur ID
$dist_passwd = le mot de passe
$newcontact = un tableau avec les données du contact
$atlds = un tableau avec la liste des TLDs que l'on cherche à enregistrer

Valeurs de retour:

Exemple PHP:

    $atlds = array( 'com','org','us','fr','link','eu','it' );
    $result = $client->check_contact_create_tlds( $dist_id, $dist_passwd, $newcontact, $atlds );

• contact_mail_waps

Envoie un mail de contrôle au titulaire d'un nom de domaine pour un gTLD ou nTLD délégué par l'ICANN.

Dans le cadre d'une procédure obligatoire que nous impose l'ICANN, (WAPS: Whois Accuracy Program Specification) nous devons effectuer une fois par an et à chaque modification des informations, une vérification de la validité des informations des titulaires de nom de domaine.

Typage:

function contact_mail_waps( $cid, $passwd, $owner_id );

$dist_id = distributeur ID
$dist_passwd = le mot de passe
$owner_id = id d'un contact titulaire de nom de domaine

Valeurs de retour:

Gestion des noms de domaine

• domain_check

Typage:

function domain_check( $dist_id, $dist_passwd, $domain )

Valeurs de retour:

    [retcode] => 1
    [retval] => 1

Exemple PHP:

    /* Controle la disponibilite d'un nom de domaine -------------------- */
 
    $domain = sprintf( "mydomaine-%d.com", time() );
 
    echo "domain_check() $domain\n";
    $result = $client->domain_check( $dist_id, $dist_passwd, $tdomain );
    print_r( $result );

Exemple Perl:

    # Controle la disponibilite d'un nom de domaine
 
    print "domain_check()\n";
    my $name= sprintf( "demo-now-%d", time() );
 
    my @adomain = map { "$name.".$_ } ('com','net','org','info','biz','name','us','eu');
 
    foreach my $domain (@adomain)
    {
        $result = $client->domain_check($dist_id, $dist_passwd,$domain);
        print "$domain\n";
        print Data::Dumper->Dump([$result->result]);
    };

• domain_multicheck

Typage:

function domain_multicheck( $dist_id, $passwd, $domain, $tlds )

$domain doit être fourni sans TLD

l'argument $tlds est facultatif, toutefois en raison du nombre de plus en plus important de TLD que nous supportons nous vous invitons a définir cette variable avec les TLDs que vous voulez fournir, faute de quoi le temps de réponse sera important.

Exemple: $tlds = “com net org info fr eu be”;

Nous avons pré-défini quelques valeurs pour $tlds:

'gtld' : tld générique historique ( com net org biz info mobi name asia tel xxx )
'ntld' : tous les nouveaux TLDs générique (a partir de 2013)
'cctld' : tous les ccTLDs
'cctld-fr' : le .fr et ses TLDs ultra-marin
'cctld-eu' : les ccTLDs en europe
'all' : l'ensemble des TLDs de l'API (attention le temps de réponse sera important.)

Pour des raisons historiques, si cette argument est absent, la fonction domain_multicheck() retourne l'information pour l'ensemble des TLDs que supporte l'API a l'exception des nTLD générique.

Valeur de retour:

Pour chaque TLD géré par l'API (1 = disponible, 0 = indisponible, 2 = .FR réservé pour une commune Française)

[retcode] => 1
[retval] => 1
[retfields] => Array
    (
        [com] => 0 
        [net] => 1
        [org] => 0
        [biz] => 1
        [info] => 1
        [mobi] => 1
        [pro] => 1
        [name] => 1
        [asia] => 1
        [xxx] => 1
        [tv] => 1
        [fm] => 1
        [it] => 1
        [de] => 1
        [eu] => 0
        [be] => 1
        [fr] => 1
        [boutique] => 1
        [photos] => 1
    )

Exemple PHP:

    /* Controle la disponibilite d'un nom de domaine -------------------- */
    /* pour l'ENSEMBLE des TLDs gere par l'API -------------------------- */
 
    $domain = sprintf( "mydomain-now-%d", time() );
    $tlds = "com net org tv fm fr be es de it";
    $result = $client->domain_multicheck( $dist_id, $dist_passwd, $domain, $tlds );
    print_r( $result );

Exemple Perl:

    # Controle la disponibilite d'un nom de domaine 
    # pour l'ENSEMBLE des TLDs gere par l'API
 
    print "domain_multicheck()\n";
    my $name= sprintf( "mydomain-now-%d", time() );
    $result = $client->domain_multicheck( $dist_id, $dist_passwd, $name);
    print Data::Dumper->Dump([$result->result]);

• domain_create

Typage:

function domain_create( $dist_id, $dist_passwd, $array_domain )

Valeurs de retour:

ATTENTION, il est ** IMPERATIF ** de contrôler l'état d'avancement d'un domain_create via la commande api_status de l'API.

[retcode] => 1
[retval] => 277
[retfields] => Array
    (
        [tid] => 277
        [id] => 141958
        [lastupdate] => 2006-09-26 21:43:09
        [lastupdate_ip] => 88.191.249.162
        [domain] => demo-now-1159299779.com
        [registrar_creation] => 0000-00-00 00:00:00
        [registrar_expiration] => 0000-00-00 00:00:00
        [authinfo] => hqruzKPTYZ13
        [service] => dns
        [status] => Active
        [registry_status] => 0
        [ns0] => ns0.online.net
        [ns1] => ns1.online.net
        [bill_id] => 13490
        [tech_id] => 13490
        [admin_id] => 13490
        [owner_id] => 151049
    )

Exemple PHP:

    /* Creation d'un nom de domaine ------------------------------------- */
 
    $domain = sprintf( "mydomaine-%d.com", time() );
 
    $newdomain = array(
        "domain"   => $domain,  // nom de domaine
        "period"   => 1,        // enregistrement pour 1 an
        "owner_id" => $id,      // contact ID cree dans le meme exemple
        "admin_id" => $admin_id, // Contact Admin = partenaire 
        "tech_id"  => $tech_id, // Contact Technique = partenaire
        "bill_id"  => $bill_id, // Contact Facturation = partenaire
        "dist_id"  => $dist_id, // Contact Revendeur
        "service"  => "dns",    // enum('parking','redir','dns','dnsslave','dnsperso')
        "ip_dns_master"  => "", // si dnsslave => fournir l'IP du master
        "ns0" => "ns0.online.net",
        "ns1" => "ns1.online.net", // jusqu'a 4 DNS possible (13 en update)
        "ipns0"  => "",
        "ipns1"  => "",         // glue record si besoin
 
        // les champs suivant sont uniquement utilise par domain_update();
        "registry_status" => 0,     // clientTransferProhibited on/off
        "authinfo" => "EPPauthCode" // EPP AuthCode
        );
 
    echo "domain_create() \n";
    $result = $client->domain_create( $dist_id, $dist_passwd, $newdomain );
    print_r( $result );
 
    if ( $result['retcode'] != 1 )
        die( "Ca ne fonctionne pas !" );

Exemple Perl:

    my $tid;
    my %newdomain;
    # Creation d'un nom de domaine
 
    print "domain_create\n";
    my $domain= 'demo-now-'.time()."-$$.com";
 
     %newdomain =(
        "domain"   => $domain,  # nom de domaine
        "period"   => 1,        # enregistrement pour 1 an
        "owner_id" => $contact_id, # contact ID cree dans le meme exemple
        "admin_id" => $dist_id, # Contact Admin =  partenaire
        "tech_id"  => $dist_id, # Contact Technique = partenaire
        "bill_id"  => $dist_id, # Contact Facturation = partenaire
        "service"  => "dns",    # dns ou dnsslave
        "ip_dns_master"  => "", # si dnsslave => fournir l'IP du master
        "ns0" => "ns0.online.net",
        "ns1" => "ns1.online.net",  # jusqu'a 13 DNS possible
        "ns2" => "ns0.$domain",     # dns avec glue => fournir son IP
        "ipns2" => "213.228.62.20"
    );
 
    $result = $client->domain_create( $dist_id, $dist_passwd, 
        SOAP::Data->type(map => \%newdomain ));
 
    print Data::Dumper->Dump([$result->result]);
 
    if ($result->result->{'retcode'} !=1)
    {
        die "Ca ne fonctionne pas !\n";
    };
    $tid = $result->result->{'retval'};

• domain_renew

Typage:

function domain_renew( $dist_id, $dist_passwd, $domain, $period )

Valeurs de retour:

Les contraintes de statuts pour domaine_renew

L'opération de renew est refusé si l'un des statuts suivant est présent:
  
clientRenewProhibited
serverRenewProhibited
clientUpdateProhibited
serverUpdateProhibited
pendingCreate
pendingDelete
pendingRenew  
pendingTransfer
pendingUpdate

Exemple PHP:

    /* Renouvellement d'un nom de domaine -------------------------------- */
 
    $period = 5; // Renouvellement pour 5 ans
 
    echo "domain_renew() \n";
    $result = $client->domain_renew( $dist_id, $dist_passwd, $newdomain['domain'], $period );
    print_r( $result );
 
    if ( $result['retcode'] != 1 )
        die( "Ca ne fonctionne pas !" );
 
    $tid = $result['retfields']['tid'];
    echo "api_status() transaction $tid\n";
    $result = $client->api_status( $dist_id, $dist_passwd, $tid );
    print_r( $result );

Exemple Perl:

    # Renouvellement d'un nom de domaine
 
    print "domain_renew()\n";
    my $period = 5; # Renouvellement pour 5 ans;
 
    $result = $client->domain_renew( $dist_id, $dist_passwd, $newdomain{'domain'}, $period );
 
    print Data::Dumper->Dump([$result->result]);
    if ($result->result->{'retcode'} !=1)
    {
        die "Ca ne fonctionne pas !\n";
    };
 
    $tid = $result->result->{'retval'};

• domain_update

Typage:

function domain_update( $dist_id, $dist_passwd, $domain, $array_domain )

Valeurs de retour:

[retcode] => 1
[retval] => 278
[retfields] => Array
    (
        [tid] => 278
    )

Les contraintes de statuts pour la fonction domain_update()

admin_id / tech_id / bill_id ne sont modifiable que si $dist_id == $owner_id ou $dist_id == $admin_id
 
L'opération de mise a jour est refusé si l'un des statuts suivant est présent:
  
clientUpdateProhibited
serverUpdateProhibited
pendingCreate
pendingDelete
pendingRenew
pendingTransfer
pendingUpdate

Les éléments indispensable a $array_domain de la commande domain_update() sont: domain, owner_id, admin_id, tech_id, bill_id, service

Les valeurs possibles pour pour la modification via l'API de 'registry_status' sont: 0 (aucun), 4 pour clientHold et 64 pour clientTransferProhibited.
Une valeur autre que zéro ne retire pas le status, la valeur 0 retire clientHold et clientTransferProhibited.

La liste de l'ensemble des valeurs possibles pour 'registry_status' est défini dans domain_info()

Exemple PHP:

    /* Update d'un nom de domaine ---------------------------------------- */
 
    // un exemple de $newdomain est defini dans domain_create
    $upddomain = $newdomain;
    // il est possible de definir jusqu'a 13 DNS
    $upddomain['ns0'] = "nsa.bookmyname.com";
    $upddomain['ns1'] = "nsb.bookmyname.com";
    $upddomain['ns2'] = "nsc.bookmyname.com";
    $upddomain['ip_dns_master'] = ""; //si dnsslave => fournir l'IP du master
    // owner_id défini a la création (non modifiable)
    $upddomain['owner_id'] = $owner_id;
    // Changement de contact Technique
    $upddomain['tech_id'] = $tech_id;
    // Changement de contact de Facturation
    $upddomain['bill_id'] = $bill_id;
    // Changement de contact de Distributeur/Revendeur
    $upddomain['dist_id'] = $dist_id;
    // 64 = Transfer Prohibited, 0 = Transfer Granted
    $upddomain['registry_status'] = 64;
    // Changement de l'AuthCode EPP
    $upddomain['authinfo'] = "NewEPPcode";
 
    echo "domain_update() \n";
    $result = $client->domain_update( $dist_id, $dist_passwd, 
        $newdomain['domain'], $upddomain );
    print_r( $result );
 
    if ( $result['retcode'] != 1 )
        die( "Ca ne fonctionne pas !\n" );
 
    $tid = $result['retfields']['tid'];
    echo "api_status() transaction $tid\n";
    $result = $client->api_status( $dist_id, $dist_passwd, $tid );
    print_r( $result );
 
    /* Exemple de configuration pour DNSSEC ---------------------------- */
 
    // Afin d'avoir le éléments à remplir dans le tableau [dsrecords], vous devez entre autre lire
    // http://api.doc.bookmyname.com/api-nom-de-domaine#info_dnssec
 
    $domain = 'mondomaine.com';
 
    echo "domain_info()\n";
    $result = $client->domain_info( $dist_id, $dist_passwd, $domain );
    if ( $result['retcode'] != 1 )
        die( "Ca fonctionne pas !\n" );
    print_r( $result );
 
    echo "domain_update()\n";
    $du['domain'] = $domain;
    // reprend les DNS du domain_info
    for ( $i=0; $i<13; $i++ )
        if ( isset($result['retfields']['ns'.$i]) )
            $du['ns'.$i] = $result['retfields']['ns'.$i];
    // reprend les contacts
    foreach( array('owner_id','admin_id','tech_id','bill_id','dist_id') as $key )
        $du[ $key ] = $result['retfields'][ $key ];
    // set EPP clientTransferProhibited
    $du['registry_status'] = 64;
    // Changement de AuthKey
    $du['authinfo'] = 'C1p3tiS3cr3t';
    // service DNS
    $du['service'] = 'dns';
    $result = $client->domain_update( $dist_id, $dist_passwd, $du['domain'], $du );
    if ( $result['retcode'] != 1 )
        die( "Ca fonctionne pas !\n" );
 
    // Exemple d'ajout de DS records DNSSEC pour un .COM
    $keytag=1234;
    $du['dsrecords'][ $keytag ]['algds']=8;
    $du['dsrecords'][ $keytag ]['digesttype']=2;
    $du['dsrecords'][ $keytag ]['digest']='444475086DF99C9BB7A9977CAC911CA67D06D0267B53F2526E521742D0631BA2';
    $keytag=4567;
    $du['dsrecords'][ $keytag ]['algds']=13;
    $du['dsrecords'][ $keytag ]['digesttype']=2;
    $du['dsrecords'][ $keytag ]['digest']='AD5144DBE76626669C569DC4D28D7AB1BC4D2D85B719248802C38931E011B6B1';
 
    // Exemple d'ajout de DS records DNSSEC pour un .EU ou .BE ou .DE ou .NL
    /*
    $keytag=1234;
    $du['dsrecords'][ $keytag ]['algds']=8;
    $du['dsrecords'][ $keytag ]['pubkey']='AwEAAdZuRfrp2jhPafgTizq2Otda4X8cOxYw9XTSY6Vz/UKERQYP0bCu bWQHw1citchFntujR4i9K9OEjgdjmq6HfvdBM5jthQlt+JLjW0efMhzB Kd3TECYYeSARmgEsNJPvdQPdpnC27DjKv+RVBI13QzibxyDIo8N68PYZ WiUruG6T+YjTUUE/4gJR5wOaK0wzr/tcPxQ8p47Pjxls8Gj+wjjp8khK 1rJdm/Ud0tdcpGQ/P2xNvm6V6v6rZ+BlBZ4KUFQe4jkEDKTsvY74NRNB yZJIj8Y8zbjdNk9CDXWnXCuY7z49zKUA3/YqAfDxhyzjXeiZZLz91q4+ 6n4t4sKzLfLdKdefwMmIUR4ttiS4aClevgN7+B9dnbzV6nUtPdL861Sf 22x7Dsuvax8/XV2Kt0SfDNHxF764RgumqMIH5Kof6sq/OiVtdTE1BER7 fEmjPGRy68y1bJDlLC9pvoDat+t43x3d799MZJ05VoJqIA58OHlZvGF6 Olvz0b7GsfCkGZikQdyA/XqZrqtFcBtNYbGnAAZq2lDP5jeDaIZ5X1TA AOqPqzMtnhE+gvl2m0YuGdo9bLcdVST+vNyQYOAbHLAfeAumitC0xzB7 LY0C/biN2eOeuvliIkbUIUJFfIKdrZdHwDOMdUnHz/dxTriIk1qdcy+c JhIiwUvtU1NVJ42B';
    */
 
    $result = $client->domain_update( $dist_id, $dist_passwd, $du['domain'], $du );
    if ( $result['retcode'] != 1 )
        die( "Ca fonctionne pas !\n" );
    print_r( $result );
 
    // Exemple pour retirer les DS records DNSSEC
    $du['dsrecords']='';
    $result = $client->domain_update( $dist_id, $dist_passwd, $du['domain'], $du );
    if ( $result['retcode'] != 1 )
        die( "Ca fonctionne pas !\n" );
 

Exemple Perl:

    # Update d'un nom de domaine
 
    print "domain_update()\n";
 
    my %upddomain = %newdomain;
 
    $upddomain{'ns0'} = "nsa.bookmyname.com";
    $upddomain{'ns1'} = "nsb.bookmyname.com";
    $upddomain{'ns2'} = "nsc.bookmyname.com";
    $upddomain{'ip_dns_master'} = ""; # si dnsslave => fournir l'IP du master
    $upddomain{'tech_id'} = $tech_id;
    $upddomain{'bill_id'} = $bill_id;
    $upddomain{'dist_id'} = $dist_id;
 
    $result = $client->domain_update( $dist_id, $dist_passwd, 
        $newdomain{'domain'}, SOAP::Data->type(map => \%upddomain) );
 
    print Data::Dumper->Dump([$result->result]);
 
    if ($result->result->{'retcode'} !=1)
    {
        die "Ca ne fonctionne pas !\n";
    };
 
    $tid = $result->result->{'retval'};

• domain_delete

Typage:

function domain_delete( $dist_id, $dist_passwd, $domain )

Valeurs de retour:

Exemple PHP:

    /* Delete d'un nom de domaine ---------------------------------------- */
 
    echo "domain_delete() \n";
    $result = $client->domain_delete( $dist_id, $dist_passwd, $newdomain['domain'] );
    print_r( $result );
 
    if ( $result['retcode'] == 1 ) {
        $tid = $result['retfields']['tid'];
 
        echo "api_status() transaction $tid\n";
        $result = $client->api_status( $dist_id, $dist_passwd, $tid );
        print_r( $result );
        }

Exemple Perl:

    # Delete d'un nom de domaine
 
    print "domain_delete()\n";
    $result = $client->domain_delete( $dist_id, $dist_passwd, $newdomain{'domain'} );
    print Data::Dumper->Dump([$result->result]);
 
    if ($result->result->{'retcode'} !=1)
    {
        die "Ca ne fonctionne pas !\n";
    };
 
    $tid = $result->result->{'retval'};

• domain_info

Typage:

function domain_info( $dist_id, $dist_passwd, $domain )

Valeurs de retour:

La valeur de 'registry_status' est un OR entre les valeurs du tableau suivant:

Les valeurs de:

[retcode] => 1
[retval] => 141958
[retfields] => Array
    (
        [id] => 141958
        [lastupdate] => 2016-09-04 15:52:48
        [lastupdate_ip] => 88.191.249.162
        [domain] => demo-now-1159299779.com
        [registrar_creation] = 2016-09-04 15:52:48
        [registrar_expiration] = 2017-09-04 15:52:48
        [registry_debut] = 2016-09-04 15:52:48
        [registry_fin] = 2017-09-04 15:52:48
        [authinfo] => hqruzKPTYZ13
        [service] => dns
        [ip_dns_master] => 
        [status] => Active
        [registry_status] => 64
        [domain_renew] = > 9
        [domain_restore] => 0
        [owner_waps] => 1
        [ns0] => ns0.free.org
        [ns1] => ns1.free.org
        [ns2] => ns3.free.org
        [dnssec] => unsigned
        [owner_id] => 151049
        [admin_id] => 13490
        [tech_id] => 127743
        [bill_id] => 127743
        [dist_id] => 0         // si valeur != 0 =>  partenaire
        [dnssec] => signed     // ou 'unsigned', si 'signed' [dsrecords] a les DS records DNSSEC
        [dsrecords] => Array
            (
                [1234] => Array
                    (
                        [algds] => 8
                        [digesttype] => 2
                        [digest] => 444475086DF99C9BB7A9977CAC911CA67D06D0267B53F2526E521742D0631BA2
                    )
                [4567] => Array
                    (
                        [algds] => 13
                        [digesttype] => 2
                        [digest] => AD5144DBE76626669C569DC4D28D7AB1BC4D2D85B719248802C38931E011B6B1
                    )
            )
 
    )

Exemple PHP:

    /* Information a propos d'un nom de domaine -------------------------- */
 
    echo "domain_info()\n";
    $result = $client->domain_info( $dist_id, $dist_passwd, $newdomain['domain'] );
    print_r( $result );

Exemple Perl:

    # Information a propos d'un nom de domaine
 
    print "domain_info()\n";
    $result = $client->domain_info( $dist_id, $dist_passwd, $newdomain{'domain'} );
    print Data::Dumper->Dump([$result->result->{'retfields'}]);

• domain_list

Typage

function domain_list( $dist_id, $dist_passwd, $role )

$role est soit vide pour obtenir la liste de tout les noms de domaine ou $dist_id est l'un des contacts, soit une string qui va contenir les champs “Owner Admin Tech Bill” avec un espace comme séparateur (pour limiter la liste aux noms de domaine ou $dist_id est contacts du/des type/s défini)

Valeurs de retour:

retourne un tableau avec les noms de domaine et la date d'expiration au registre sous la forme d'un décimal qui représente le nombre de seconde depuis le 1 Janvier 1970, 0h, 0m, 0s UTC (voir time(3))

Exemple PHP:

    /* Liste des domaines (et date d'expiration) dont le partenaire ------- */
    /* $dist_id est l'un des contacts (Owner/Admin/Tech/Bill) ------------ */
 
    echo "domain_list() contact $dist_id\n";
    $result = $client->domain_list( $dist_id, $dist_passwd );
    print_r( $result );

Exemple Perl:

    # Liste des domaines (et date d'expiration) dont le partenaire
    # $dist_id est l'un des contacts (Owner/Admin/Tech/Bill)
 
    print "domain_list() contact $dist_id\n";
    $result = $client->domain_list( $dist_id, $dist_passwd );
    print Data::Dumper->Dump([$result->result->{'retfields'}]);

• domain_transfer

Typage:

function domain_transfer( $dist_id, $dist_passwd, $domain, $authkey, $extid, $forcedns )

$extid c'est le numéro d'id d'un contact qui est utilisé comme titulaire du nom de domaine dans le cas ou n'est pas possible de l'obtenir auprès de l'ancien bureau d'enregistrement.

$forcedns, tableau de DNS qui permet de faire un changement de DNS en même temps qu'un changement de bureau d'enregistrement.

Valeurs de retour:

En cas d'échec de transfert (authkey invalide, non réponse au vote, e-mail du whois de l'ancien registrar invalide, etc.) il est possible de le relancer par la commande 'domain_transfer()'. Cette opération de relance n'engendre aucune facturation.

ATTENTION: pour les gTLD la commande domain_transfert() envoi automatiquement un e-mail de demande d'acceptation du transfert au titulaire et admin contact du nom de domaine. Ce mail est envoye avec un From: et des URL propre a chaque distributeur.

domain_transfer() retourne un tableau retfields[]

      [retfields] => Array
          (
          
              [tid] = 6070148
              [owner_id] = 1184377
              [validhash] = 8173a877f7bce2ba
              [parent_id] = 12345
              [lastupdate] = 2018-04-14 17:11:54
              [lastupdate_ip] = 1.2.3.4
              [handle] = DUMMY12345-FREE
              ...
          )

Exemple PHP:

    /* Transfert d'un nom de domaine ------------------------------------- */
    /* ATTENTION: pour les gTLD envoi un e-mail de demande d'acceptation   */
    /* du transfert au titulaire et admin contact du nom de domaine        */
 
    $domain = "un-de-mes-domaines.com";
    $authkey = "1234secret5678";
    $result = $client->domain_transfer( $dist_id, $dist_passwd, $domain, $authkey, $owner_id );
    print_r( $result );
 
    /* relance un transfert */
    $authkey = "NewSecret5678";
    $result = $client->domain_transfer( $dist_id, $dist_passwd, $domain, $authkey, $owner_id );
    print_r( $result );

Exemple Perl:

    # Transfert d'un nom de domaine
 
    print "domain_transfer() un-de-mes-domaines.com\n";
    $result = $client->domain_transfer( $dist_id, $dist_passwd, 
        "un-de-mes-domaines.com", SOAP::Data->type(string =>"123secret456"), $owner_id );
 
    if ($result->result->{'retcode'} !=1)
    {
        die "Ca ne fonctionne pas !\n";
    };
    $tid = $result->result->{'retval'};

• domain_transferable

Typage:

function domain_transferable( $dist_id, $dist_passwd, $domain, $authkey, $extid )

$extid c'est le numéro d'id d'un contact qui est utilisé comme titulaire du nom de domaine dans le cas ou n'est pas possible de l'obtenir auprès de l'ancien bureau d'enregistrement.

Valeurs de retour:

Cette fonction permet de controler qu'il est possible de lancer le domain_transfer() d'un nom de domaine. (controle du authkey,etc.)

• domain_trade

Typage:

function domain_trade( $dist_id, $dist_passwd, $domain, $newowner_id )

$newowner_id est le numéro d'id d'un contact.

Valeurs de retour:

La fonction domain_trade() est utilisable pour les TLDs: 'fr','eu','be','re','wf','tf','pm','yt','ch','lu','it','me','tw','us','tv','cc','la','pw','de' ainsi que l'ensemble des gTLDs et nTLDs (.com .net .org …)

Pour l'ensemble des gTLDs et nTLDs l'opération se réalise par le vote de l'actuel et du nouveau titulaire via des liens spécifique reçu par email.

La fonction api_status() vous permet de suivre l'avancement d'un Trade (par exemple qui a ou non déjà voté)

Exemple de retour de commande domain_trade()

[retcode] => 1
[retval] => 141958
[retfields] => Array
    (
        [tid] => 141958
        [tld] => "eu"
        [faxseller] => "http://www.bookmyname.com/getfaxtrade.cgi?cid=1234&mode=0"
        [faxbuyer] => "http://www.bookmyname.com/getfaxtrade.cgi?cid=1234&mode=1"
    )

[retcode] => 1
[retval] => 141958
[retfields] => Array
    (
        [tid] => 141958
        [tld] => "com"
    )

• domain_transfer_out

Typage:

function domain_transfer_out( $dist_id, $dist_passwd, $domain, $authkey, $mode )

$mode = “TransferReject” ou “TransferApprove”

Valeurs de retour:

• domain_restore

Typage:

function domain_restore( $dist_id, $dist_passwd, $domain )

Cette fonction n'est utilisable qu'avec les TLD .COM .NET .ORG .EU .BE et .FR

Valeurs de retour:

• domain_restoreable

Typage:

function domain_restorable( $dist_id, $dist_passwd, $domain )

Cette fonction n'est utilisable qu'avec les TLD .COM .NET .ORG .EU .BE et .FR

Valeurs de retour:

Cette fonction permet de controler qu'il est possible de lancer le domain_restore() d'un nom de domaine.

• domain_price

Typage:

function domain_price( $dist_id, $dist_passwd, $domain, $period )

Valeurs de retour:

Cette fonction permet de connaitre le prix des operations qu'il est possible de faire pour un nom de domaine.

Exemple:

  $domain = "domaine-de-test.com";
  $period = 10;
  $result = $client->domain_price( $dist_id, $dist_passwd, $domain, $period );
  print_r( $result );
  
  // les valeurs de retour sont toujours en centimes d'euros
  
  // exemple pour nom de domain de domain qui n'existe pas dans la base
  [retcode] => 1
  [retval] => 11
  [retfields] => Array
      (
          [create 1 domaine-de-test.com] => 790
          [create 2 domaine-de-test.com] => 1580
          [create 3 domaine-de-test.com] => 2370
          [create 4 domaine-de-test.com] => 3160
          [create 5 domaine-de-test.com] => 3950
          [create 6 domaine-de-test.com] => 4740
          [create 7 domaine-de-test.com] => 5530
          [create 8 domaine-de-test.com] => 6320
          [create 9 domaine-de-test.com] => 7110
          [create 10 domaine-de-test.com] => 7900
          [transfer 1 domaine-de-test.com] => 790
      )
  [exectime] => 0.028565

  // exemple pour un .be qui existe
  [retcode] => 1
  [retval] => 1
  [retfields] => Array
      (
          [renew 1 domaine-de-test.be] => 520
      )
  [exectime] => 0.029040

Gestion des services (redirection)

ATTENTION, l'utilisation du service de redirection engendre systématiquement le remplacement des DNS du nom de domaine par ceux configurés pour nos services.

• service_redir_create

Typage

function service_redir_create( $dist_id, $passwd, $domain, $type, $source, $destination )

Valeurs de retour:

$type doit avoir l'une des valeurs :

'web' pour les redirections web (de type 302)
'web302' pour les redirections web (de type 302)
'web301' pour les redirections web (de type 301)
'rweb' pour les redirections web transparente (avec frame)
'mail' pour les redirections mail

 Si $type == 'web' ou 'rweb' ou 'web302' ou 'web301'

  'source' est de la forme : http://qqchose.mondomaine.tld
  'destination' est de la forme: http://sous-domaine.domaine.tld/repertoire/fichier.html
  
  la destination peut etre une URL http, https ou ftp
 
 Si $type == 'email'

  'source' est de la forme : webmaster@mondomaine.tld
  'destination' est de la forme : mon.nom@monfai.tld

  la source comme la destination doivent etre syntaxiquement valide voir RFC
  et un A ou MX doit exister pour le nom de domaine de destination.

• service_redir_list

Typage

function service_redir_list( $dist_id, $passwd, $domain, $type )

Valeurs de retour:

$type doit avoir l'une des valeurs :

'web' pour les redirections web
'web301' pour les redirections web de type 301
'web302' pour les redirections web de type 302
'rweb' pour les redirections web transparente (avec frame)
'mail' pour les redirections mail

La liste des redirections est dans 'retfields' exemple:

  [retfields] => Array
      (
          [http://create.registrarfrance.com] => http://www.bookmyname.com/create.cgi
          [http://blog.registrar.com]         => http://blog.bookmyname.com/parlerpournedire.html
      )

• service_redir_delete

Typage

function service_redir_delete( $dist_id, $passwd, $domain, $type, $source, $destination )

Valeurs de retour:

$type doit avoir l'une des valeurs :

'web' pour les redirections web
'rweb' pour les redirections web transparente (avec frame)
'mail' pour les redirections mail

• service_dns_custom_get

Typage

function service_dns_custom_get( $dist_id, $passwd, $domain )

Valeurs de retour:

Exemple PHP:

    $domain = "dnsperso-nom-de-domaine.com";
    $result = $client->service_dns_custom_get( $dist_id, $dist_passwd, $domain );
    if ( $result['retcode'] == -1 ) {
        // erreur
        }
    print_r( $result );

La liste des entrees de la zone DNS est dans 'retfields' exemple:

  [retfields] => Array
      (
          [0] => Array
              (
                  [name] => blog
                  [ttl] => 28800
                  [type] => CNAME
                  [value] => dublabla.registrarfrancais.com.
              )
          [1] => Array
              (
                  [name] => www
                  [ttl] => 28800
                  [type] => A
                  [value] => 88.191.249.162
              )
          [2] => Array
              (
                  [name] => ipv6-free
                  [ttl] => 28800
                  [type] => AAAA
                  [value] => 2a01:5d8:e200::1
              )
)

• service_dns_custom_set

Typage

function service_dns_custom_set( $dist_id, $passwd, $domain, $zone )

Valeurs de retour:

La zone DNS presente dans $zone, peu contenir des entrees de type: A MX NS CNAME AAAA WKS TXT SRV

Exemple PHP:

    $domain = "dnsperso-nom-de-domaine.com";
    $zone = "www A 88.191.249.162\nmail A 88.191.249.132\n".$domain.". MX 10 mail\n";
    $result = $client->service_dns_custom_set($dist_id, $dist_passwd, $domain, $zone);

• service_mbox_create

Typage

function service_mbox_create( $dist_id, $passwd, $domain, $mbox_name, $mbox_passwd, $mbox_quota )

Valeurs de retour:

• service_mbox_delete

Typage

function service_mbox_delete( $dist_id, $passwd, $domain, $mbox_name )

Valeurs de retour:

• service_mbox_list

Typage

function service_mbox_list( $dist_id, $passwd, $domain )

Valeurs de retour:

Gestion des hosts (glue record)

• host_create

Typage

function host_create( $dist_id, $passwd, $hostname, $array_ip )

Valeurs de retour:

Exemple PHP:

    /* Creation d'une glue record sur un nom de domaine que l'on gere ---- */
 
    /* glue record a plusieurs IPs */
    $array_ip = array ( "88.191.249.1", "88.191.249.2", "88.191.249.3" );
    $hostname = "glue1.".$domain;
 
    echo "host_create() $hostname\n";
    $result = $client->host_create( $dist_id, $dist_passwd, $hostname, $array_ip );
    print_r( $result );
 
    $array_ip = array ( "88.191.249.4", "88.191.249.5" );
    $hostname = "glue2.".$domain;
    echo "host_create() $hostname\n";
    $result = $client->host_create( $dist_id, $dist_passwd, $hostname, $array_ip );
    print_r( $result );
 
    /* le cas le plus frequent, juste une IP pour la glue */
    $array_ip = array ( "88.191.249.6" );
    $hostname = "glue3.".$domain;
    echo "host_create() $hostname\n";
    $result = $client->host_create( $dist_id, $dist_passwd, $hostname, $array_ip );
    print_r( $result );
 
    /* glue directement sur le nom de domaine */
    $array_ip = array ( "88.191.249.7" );
    $hostname = $domain;
    echo "host_create() $hostname\n";
    $result = $client->host_create( $dist_id, $dist_passwd, $hostname, $array_ip );
    print_r( $result );

Exemple Perl:

    # creation d'un host
 
    my $hostname;
    print "host_create()\n";
    $hostname = "ns1test-$$.bookmyname.com";
    print "ns1test-$$.bookmyname.com\n";
    my @ips =  ("88.191.249.1","88.191.249.2", "88.191.249.3" );
    $result = $client->host_create( $dist_id, $dist_passwd, 
        $hostname, SOAP::Data->type(Array => \@ips));
    if ($result->result->{'retcode'} !=1)
    {
        print Data::Dumper->Dump([$result->result]);
        die "Ca ne fonctionne pas !\n";
    };
    $tid = $result->result->{'retval'};

• host_update

Typage:

function host_update( $dist_id, $passwd, $hostname, $array_ip )

Valeurs de retour:

Exemple PHP:

    /* Update d'une glue ------------------------------------------------- */
 
    $hostname = "glue3.".$domain;
    $array_ip = array ( "88.191.249.6", "88.191.249.5", "88.191.249.4" );
    echo "host_update() $hostname\n";
    $result = $client->host_update( $dist_id, $dist_passwd, $hostname, $array_ip );
    print_r( $result );

Exemple Perl:

    # update d'un host
 
    print "host_update()\n";
    my @ips =  ("88.191.249.6");
 
    $result = $client->host_update( $dist_id, $dist_passwd, $hostname, 
        SOAP::Data->type(Array => \@ips));
    if ($result->result->{'retcode'} !=1)
    {
        print Data::Dumper->Dump([$result->result]);
        die "Ca ne fonctionne pas !\n";
    };
    $tid = $result->result->{'retval'};

• host_delete

Typage:

function host_delete( $dist_id, $passwd, $hostname )

Valeurs de retour:

Exemple PHP:

    /* Delete d'une glue ------------------------------------------------- */
 
    $hostname = "glue2.".$domain;
    echo "host_delete() $hostname\n";
    $result = $client->host_delete( $dist_id, $dist_passwd, $hostname );
    print_r( $result );

Exemple Perl:

    # delete d'un host
 
    print "host_delete()\n";
    $result = $client->host_delete( $dist_id, $dist_passwd, $hostname );
 
    if ($result->result->{'retcode'} !=1)
    {
        print Data::Dumper->Dump([$result->result]);
        die "Ca ne fonctionne pas !\n";
    };
    $tid = $result->result->{'retval'};

• host_list

Typage:

function host_list( $dist_id, $passwd, $domain )

Valeurs de retour:

• host_info

Typage:

function host_info( $dist_id, $passwd, $hostname )

Valeurs de retour:

[retcode] => 1
[retval] => 13128
[retfields] => Array
    (
        [id] => 13128
        [hostname] => glue2.demo-now-1159299779.com
        [lastupdate] => 2006-09-26 21:43:10
        [ip0] => 88.191.249.4
        [ip1] => 88.191.249.5
    )

Exemple PHP:

    /* Liste des glues record d'un nom de domaine ------------------------ */
 
    echo "host_list() \n";
    $result = $client->host_list( $dist_id, $dist_passwd, $domain );
    print_r( $result );
 
    if ( $result['retcode'] != 1 )
        die( "Ca ne fonctionne pas !" );
 
    /* Information sur les IPs d'un hostname qui a une glue -------------- */
 
    $gluelist = $result['retfields'];
    for( $i=0; $i<count($gluelist); $i++ ) {
        $hostname = $gluelist[$i]['hostname'];
        echo "host_info() $hostname\n";
        $result = $client->host_info( $dist_id, $dist_passwd, $hostname );
        print_r( $result );
        }

Exemple Perl:

    # Les hosts d'un domaine et leurs ips
    # Hosts List && host_info
 
    print "host_list()\n";
    $result = $client->host_list($dist_id, $dist_passwd, 'bookmyname.com');
 
    if ($result->result->{'retcode'} !=1)
    {
        print Data::Dumper->Dump([$result->result]);
        die "Ca ne fonctionne pas !\n";
    };
    foreach my $host (map { $_->{'hostname'} } @{$result->result->{'retfields'}})
    {
        print "$host\n";
        $result = $client->host_info($dist_id, $dist_passwd,$host);
        if($result->result->{'retcode'} ==1)
        {
            print Data::Dumper->Dump([$result->result->{'retfields'}]);
        };
    };

Les fonctions propre à l'API

• api_status

Typage:

function api_status( $dist_id, $dist_passwd, $tid, $restart )

 $tid = transaction ID 
  valeur de retour d'une des commandes:
  . domain_create, domain_renew, domain_update, domain_delete, domain_transfer, domain_trade
  . host_create, host_update, host_delete

 $restart (absent ou a 0) => aucune action
           valeur a 1 => relance une operation en erreur (status='Error')
           ou relance in domain_transfer() ou domain_trade()
           valeur a 2 => renvoi l'email de vote au titulaire pour domain_trade()
           valeur a 3 => renvoi l'email de vote au futur/titulaire pour domain_trade()

Valeurs de retour:

En cas de relance d'email pour domain_trade() la valeur de retour de TID est 1 si tout est OK

Les causes de refus de relance sont:

retourne un tableau retfields[]

      Exemple pour un domain_create()en cours de création, ou domain_transfer(), domain_trade():

      [retfields] => Array
          (
              [tid] => 375
              [transaction_id] => 375
              [lastupdate] => 2006-10-04 17:04:56
              [requestdate] => 2006-10-04 17:04:56
               
              [action] => Create
              [reply_value] => 0
              [reply_msg] =>
              [period] => 1
              [type] => Domain
              [status] => ToProcess
              
              ou
              [action] = TransferRequest
              [transin_etat] = Pending
              [transin_lastupdate] = 2016-07-26 09:08:08
              [transin_date_request] = 2016-07-26 09:08:03
              [transin_authinfo] = TresSecret1234
              [transin_email_owner] = email@domain.tld
              [transin_email_admin] = email@domain.tld
              [transin_vote_owner] = 0
              [transin_vote_date_owner] = 0000-00-00 00:00:00
              [transin_vote_ip_owner] =
              [transin_vote_admin] = 0
              [transin_vote_date_admin] = 0000-00-00 00:00:00
              [transin_vote_ip_admin] =
              [transin_owner_cid] = 123456
              [transin_validhash] = 6aa89763e2e6af70
              [transin_history] =
                  
              ou
              [action] = Trade
              [trade_etat] = AttenteVote
              [trade_lastupdate] = 2016-08-01 03:10:31
              [trade_date_request] = 2016-08-01 11:46:21
              [trade_owner_cid] = 123456
              [trade_newowner_cid] = 1234567
              [trade_email_owner] = email@domain.tld
              [trade_email_newowner] = newemail@domainnew.tld
              [trade_vote_owner] = 2016-08-01 12:13:14
              [trade_vote_ip_owner] = 127.0.0.123
              [trade_vote_newowner] = 0000-00-00 00:00:00
              [trade_vote_ip_newowner] = 
                  
          )
            
      Le contenu possible est :
         
      pour 'reply_value' et 'reply_msg': messages fourni par le registre 
             (verisign, pir, afilias, gnr, neulevel, dns.be, eurid, etc.)

      pour 'status': enum('Wait','ToProcess','Done','Error');

      pour 'type'  : enum('Contact','Domain','Host','Other');

      pour 'action': enum('Create','Renew','Update','Delete','Restore','Trade',
                          'TransferRequest','TransferCancel',
                          'TransferApprove','TransferReject' );

Le temps de traitement d'une transaction varie de quelques secondes (dans la majorité des cas) à plusieurs minutes voir heures lorsque les registres sont en maintenance, ce qui pour certain registre est fréquent (une fois par semaine).

Exemple PHP:

    /* api_status (pour connaitre l'etat d'une operation (fini,etc.) ----- */
 
    $tid = $transaction_id; // souvent present dans $result['retfields']['tid'];
    echo "api_status() transaction $tid\n";
    $result = $client->api_status( $dist_id, $dist_passwd, $tid );
    print_r( $result );

Exemple Perl:

    # api_status (pour savoir lorsque l'operation est fini)
 
    print "api_status() transaction $tid\n";
 
    $result = $client->api_status( $dist_id, $dist_passwd, $tid );
    print Data::Dumper->Dump([$result->result]);

• api_pending_status

Typage:

function api_pending_status( $dist_id, $dist_passwd, $period )

 $period (en mois de 1 a 12). Si absent = 4 mois.

Valeurs de retour:

retourne un tableau retfields[]

Exemple de contenu:

 [0] => Array
  (
   [transaction_id] => 12345678
   [lastupdate] => 2010-12-01 16:00:26
   [requestdate] => 2010-12-01 16:00:17
   [action] => TransferRequest
   [reply_value] => 0
   [reply_msg] =>
   [type] => Domain
   [status] => ToProcess
   [domain] => un-nom-de-domaine.fr
   [etat] => Pending
  )
 [2] => Array
  (
   [transaction_id] => 12345679
   [lastupdate] => 2010-12-01 16:00:11
   [requestdate] => 2010-12-01 16:00:11
   [action] => TransferRequest
   [reply_value] => 0
   [reply_msg] =>
   [type] => Domain
   [status] => Wait
   [domain] => un-nom-de-domaine.com
   [etat] => AttenteVote 
  )
 [3] => Array
  (
   [transaction_id] => 12345680
   [lastupdate] => 2010-11-27 07:40:40
   [requestdate] => 2010-11-27 07:40:09
   [action] => Restore
   [reply_value] => 2304
   [reply_msg] => DomainReactivate un-nom-de-domaine.eu Object status prohibits operation
   [type] => Domain
   [status] => Error
   [domain] => un-nom-de-domaine.eu
  )
 [4] => Array
  (
   [transaction_id] => 12345681
   [lastupdate] => 2010-11-26 11:35:11
   [requestdate] => 2010-11-26 11:35:05
   [action] => Create
   [reply_value] => 2306
   [reply_msg] => ContactCreate BMN-1234567 [AAA1234-FREE / 123456] Parameter value policy error 'trademark' element value seems to be syntaxically incorrect according AFNIC rules
   [type] => Domain
   [status] => Error
   [domain] => un-nom-de-domaine.fr
  )
 [5] => Array
  (
   [transaction_id] => 12345682
   [lastupdate] => 2010-11-22 18:35:29
   [requestdate] => 2010-11-22 18:35:04
   [action] => Create
   [reply_value] => 2005
   [reply_msg] => ContactCreate BMN-1234567 [AAA1234-FREE / 123456] Parameter value syntax error
   [type] => Domain
   [status] => Error
   [domain] => un-nom-domaine.eu
  )
 [6] => Array
  (
   [transaction_id] => 1595671
   [lastupdate] => 2010-11-03 22:32:58
   [requestdate] => 2010-09-24 21:20:05
   [action] => TransferRequest
   [reply_value] => 2202
   [reply_msg] => DomainTransfer un-nom-de-domaine.com request Invalid authorization information
   [type] => Domain
   [status] => Error
   [domain] => un-nom-de-domaine.com
   [etat] => AuthKO
  )
 [7] => Array
  (
   [transout_id] => 123456
   [domain] => un-domain-transout-pending.com
   [type] => Domain
   [etat] => TransOut
   [status] => Pending
   [reply_value] => 0
   [reply_msg] => 
   [date_notify] => 2017-10-24 12:29:28
   [registrar_name] => NAME (IANA number)
  )

• api_paysid

Typage:

function api_paysid( $dist_id, $dist_passwd )

Valeurs de retour:

Exemple PHP:

    // liste les pays_id (utilise pour les contacts)
    $result = $client->api_paysid(); 
    print_r( $result );

Exemple Perl:

    # liste les pays_id (utilise pour les contacts)
    $result = $client->api_paysid();
    if ($result->result->{'retcode'}==1)
    {
        for (my $cpt=0;$cpt<$result->result->{'retval'};++$cpt)
        {
            print Data::Dumper->Dump([$result->result->{'retfields'}->[$cpt]]);
        };
    };

• api_regionsid

Typage:

function api_regionsid( $dist_id, $dist_passwd )

Valeurs de retour:

Exemple PHP:

    // liste les regions_id (utilise pour les contacts)
    $result = $client->api_regionsid();
    print_r( $result );

Exemple Perl:

    # liste les regions_id (utilise pour les contacts)
 
    $result = $client->api_regionsid();
    if ($result->result->{'retcode'}==1)
    {
        for (my $cpt=0;$cpt<$result->result->{'retval'};++$cpt)
        {
            print Data::Dumper->Dump([$result->result->{'retfields'}->[$cpt]]);
        };
    };

• api_fr_cpville

Typage:

function api_fr_cpville( $dist_id, $dist_passwd )

Valeurs de retour:

Exemple PHP:

    // liste code postal / ville Francaise 
    // (utile dans le cas du lieu de naissance des contacts pour les .FR)
    $result = $client->api_fr_cpville();
    print_r( $result );

• api_tlds

Typage:

function api_tlds( $dist_id, $dist_passwd )

Valeurs de retour:

Exemple PHP:

    // liste les TLDs que gere l'API
    $result = $client->api_tlds();
    print_r( $result );

Exemple Perl:

    # liste les TLDs que gere l'API
 
    $result = $client->api_tlds();
    if ($result->result->{'retcode'}==1)
    {
        for (my $cpt=0;$cpt<$result->result->{'retval'};++$cpt)
        {
            print Data::Dumper->Dump([$result->result->{'retfields'}->[$cpt]]);
        };
    };

• api_dnssec_tlds

Typage:

function api_dnssec_tlds( $dist_id, $dist_passwd )

Valeurs de retour:

Exemple PHP:

    // liste les TLDs avec support de DNSSEC via l'API
    $result = $client->api_dnssec_tlds();
    print_r( $result );

• api_priceslist

Typage:

function api_priceslist( $withpromo=1 )

Valeurs de retour:

Exemple PHP:

    // liste les prix des operations pour chaque TLDs que gere l'API avec les promotions en cours
    $result = $client->api_priceslist(1);
    print_r( $result );
 
    // liste les prix des operations pour chaque TLDs que gere l'API SANS les promotions en cours
    $result = $client->api_priceslist(0);
    print_r( $result );

Exemple Perl:

    # liste les prix des operations pour chaque TLDs que gere l'API
 
    $result = $client->api_priceslist();
    if ($result->result->{'retcode'}==1)
    {
        for (my $cpt=0;$cpt<$result->result->{'retval'};++$cpt)
        {
            print Data::Dumper->Dump([$result->result->{'retfields'}->[$cpt]]);
        };
    };

• api_info

Typage:

function api_info( $dist_id, $dist_passwd )

Valeurs de retour:

Exemple PHP:

    // Information sur un compte distributeur (credit, rib, etc)
    $result = $client->api_info( $dist_id, $dist_passwd );
    print_r( $result );

• api_invoice_list

Typage:

function api_invoice_list( $dist_id, $dist_passwd )

Valeurs de retour:

Exemple PHP:

    // liste les factures id, period, montant sur 36 mois.
    $result = $client->api_invoice_list( $dist_id, $dist_passwd );
    print_r( $result );

retourne un tableau retfields[]

Exemple de contenu:

  [retcode] => 1
  [retval] => 3
  [retfields] => Array
      (
          [0] => Array
              (
                  [facture_id] => 1234
                  [period] => 2023-02
                  [montant] => 4516.4800
              )
          [1] => Array
              (
                  [facture_id] => 5678
                  [period] => 2023-01
                  [montant] => 5794.2400
              )
          [2] => Array
              (
                  [facture_id] => 9012
                  [period] => 2022-12
                  [montant] => 4161.1100
              )
      )
  [exectime] => 0.039386

Exemple Perl:

    # liste les factures id, period, montant sur 36 mois.
    $result = $client->api_invoice_list( $dist_id, $dist_passwd );
    print Data::Dumper->Dump([$result->result]);