Co se týče
Technika
Operace

SOAPI OVH


Seznamte se s API od OVH, založeném na SOAP a WSDL. Klikněte zde.



Co to je?

Předplacená služba je způsob, jak platit věrnostními body.
Založeno na systému běžných příkazů nebo na systému automatizace příkazů.
100 bodů na Vašem účtu odpovídá 25 Kč.



Tarify

Jeden bod odpovídá 25 haléřům bez DPH.
Při nákupu bodů je DPH zahrnuta.




Použití bodů:

Body lze zaplatit libovolnou objednávku z objednávkového systému.
Pomocí jednoduchého pravidla "100 bodů = 25 Kč bez DPH", si můžete jednoduše zjistit kolik bodů potřebujete na zaplacení Vaší objednávky.

Příklad: Mám objednávku na dedikovaný server. 136,15  bez DPH (164,74 Kč s DPH) Ze svého účtu mohu zaplatit 13 615 body.



Přeprodejci:

Le pack commercial web propose les noms de domaine à des tarifs ultra préférentiels, au plus près de ceux pratiqués par les Registres comme l’Afnic, Verisign, Nominet, DNSbe, ou encore Eurid.

Automatizace pomocí batch-mail


Tento systém umožňuje převádět Vaše body na objednávky a zefektivnit operace se službami.

Proces převodu je prováděn zasláním formátovaného e-mailu na adresu batch@ovh.com, nebo použitím SOAPI. Tento e-mail musí splňovat syntaxi definovanou níže a musí být autentizován následující metodou: heslo, MD5 podpis, PGP či MIME.

Zvorový příklad:
  • 1. Vytvoření objednávky/operace podle syntaxe definované níže
  • 2. Autentifikace objednávky jednou z následujících metod: heslo, MD5 podpis, PGP či SMIME
  • 3. Zaslání objednávky e-mailem na batch@ovh.com
    (použijte batch-test@ovh.com jestliže to chcete otestovat)

Zde jsou pravidla pro vytvoření e-mailu:
  • Systém na předplacení nezahrnuje formátovaný mail a zaslaný jako text batch@ovh.com
  • Jestliže používáte MD5 autentizaci, podpisy musí být přidány na konec e-mailu v textové podobě.
  • Nepřikládejte přílohy.

Neváhejte použít adresu batch-test@ovh.com což Vám umožní simulovat objednávku/operaci a tím Vás blíže seznámit s mail systémem.

Batch-mail generátor je Vám kdyspozici v (Manažeru), sekci Správa > Věrnostní program > Nástroj pro automatizaci.






Seznam objednávek/dostupných operací


Vytváření/Převod domén

                    ## this section specify batch options

                    batch.version: 4.0
                    batch.account: XXXXX-ovh
                    batch.referer: ma-ref-123456
                    batch.type: orderDomain
                    batch.auth.method: md5
                    batch.autopayment: yes

                    ## this section specify order

                    order.domain.name: ovh.com
                    order.domain.command: create    # can be: create | transfer | renew
                    order.offer: gold               # can be: gold | platine | diamond

                    ## this section specify owner

                    # give either contact.owner.id or contact.owner.<name|firstname|...>
                    contact.owner.legalform: corporation # can be: corporation | individual | association | other
                    contact.owner.vat:
                    contact.owner.name: XXXX
                    contact.owner.firstname: XXXXX
                    contact.owner.organisation: XXX
                    contact.owner.email: XXX@XXXX.net
                    contact.owner.address: XXX XXX XXX XXX
                    contact.owner.city: XXXXXX
                    contact.owner.zip: XXXXX
                    contact.owner.country: FR
                    contact.owner.language: fr
                    contact.owner.phone: +33.XXXXXXXX
                    contact.owner.fax:

                    ## this section specify contacts

                    contact.tech.id: ve174-ovh
                    # give either contact.tech.id or contact.tech.<name|firstname|...>
                    contact.admin.id: ve174-ovh
                    # give either contact.admin.id or contact.admin.<name|firstname|...>
                    contact.billing.id: ve174-ovh
                    # give either contact.billing.id or contact.billing.<name|firstname|...>

                    ## this section is mandatory for .fr

                    option.identification.method: birthPlace # can be: siren | inpi | birthPlace | afnicIdent
                    option.identification.legalName: XXX
                    option.identification.legalNumber: 123456789
                    option.identification.afnicIdent:
                    option.identification.birthDate: 01/01/2008
                    option.identification.birthCity: XXXXXX
                    option.identification.birthDepartement: XX
                    option.identification.birthCountry: FR

                    ## this section let you specify dns, not needed if you take a sharedHosting

                    option.dns.group: hosting # can be: hosting | dedicated | external
                    option.dns.master: dns12.ovh.net
                    option.dns.slave1: ns12.ovh.net
                    option.dns.slave2: XXXX.ovh.net 127.0.0.1
                    option.dns.slave3:
                    option.dns.slave4:

                    ## authinfo code for gTlds and .pl transfer

                    option.domain.authinfo: XXXXXXXXXXXXXXX

                    ## allow you protect your whois data in gtlds domain names

                    option.owo: yes
                        
                      






Obnovení domén

                    batch.version: 4.0
                    batch.account: XXXXX-ovh
                    batch.referer: ma-ref-123456
                    batch.type: orderDomain
                    batch.auth.method: md5
                    batch.autopayment: yes

                    order.domain.name: ovh.com
                    order.domain.command: renew

                    batch.auth.md5: b0a24f10d535d1b9ef40e50e97a0c312
                        
                      






Volání funkcí SOAPI: Změna domény DNS

                        batch.version: 4.0
                        batch.account: XXXXXX-ovh
                        batch.referer: ma-ref-123456
                        batch.type: soapi
                        batch.auth.method: md5
                        batch.autopayment: yes

                        soapi.method: domainDnsUpdate
                        soapi.param.domain: ovh.com
                        soapi.param.dns1: dns12.ovh.net 
                        soapi.param.dns2: ns12.ovh.net
                        
                      






Vysvětlení autentifikačních metod




Podpis MD5


Jde o metodu založenou na počítání MD5 hash e-mailu, který zašlete. Když používáte tuto metodu stačí pouze:
  • uvést, že používáte metodu MD5
    batch.auth.method: md5
  • počítat MD5 hash e-mailu. Můžete použít skript v Perl či PHP, který je uveden níže

  • přidat na konec e-mailu hash
    batch.auth.md5: 9b02cb2890ce787fdfeef72473a7a149

Skript pro generování MD5 v Perl

                         #!/usr/bin/perl
                         use strict;
                         use Digest::MD5 qw(md5_hex);

                         # fichier à signer
                         my $file = "email.txt";
                         
                         my $body;
                         open (F, $file);
                         while(<F>) {
                            $body.=$_;
                            print $_;
                         }
                         close(F);

                         my $passphrase = "MaPassPhraseQuiEstUnique";
                         my $texte_a_hasher = $passphrase.$body;
                         $texte_a_hasher =~ s/\s//g;

                         # génération du MD5
                         my $signature = md5_hex($texte_a_hasher);

                         $body .= "batch.auth.md5: $signature\n";
                         print $body;
                                  
                                  


Skript pro generování MD5 v PHP

                         <?
                         // ouverture du fichier source
                         $body = @file_get_contents("email.txt");

                         // PassPhrase saisie dans le MANAGER
                         $passphrase = 'MaPassPhraseQuiEstUnique';

                         $texte_a_hasher = preg_replace('/\s/','',$passphrase.$body);

                         //génération du MD5
                         $signature = md5($texte_a_hasher);
                         $body .= 'batch.auth.md5: '.$signature;

                         // Affichage du Mail à envoyer
                         echo "$body\n" ;
                         ?>
                                  
                                  



Tabulka povinných a volitelných částí


Povinné údaje jsou označeny pomocí volitelné sekce jsou označeny pomocí "volitelné"

create Převod Obnovení soapi
batch
objednávka
contact
volitelné volitelné volitelné
soapi






Přeměna bodů v objednávce domény


Batch


batch.version


Musí označovat číslo verze

příklad:
batch.version: 4.0

batch.account


Musí označovat NIC-Handle zaplacené objednávky. Jestliže používáte předplacený účet, transakce je prováděna na NIC-Handle.

příklad:
batch.account: XXXXXX-OVH

batch.referer


Můžete specifikovat odkaz pro identifikaci požadavku.

příklad:
batch.referer: ma-ref-123456

batch.type


Musí označovat typ aplikace. Přípustné hodnoty jsou: 'orderDomain' pro vytvoření, obnovení, nebo převod domény a 'soapi' pro dotaz pomocí SOAPI.

příklad:
batch.type: orderDomain

batch.auth.method


Metody autentifikace: md5, pgp, smime nebo plain. Pro více informací o autentifikačních metodách se podívejte na technická stránka o předplacených službách.

příklad:
batch.auth.method: md5

batch.autopayment


Musí být vyznačeno, zda bude objednávka placena pomocí předplaceného účtu.

příklad:
batch.autopayment: yes






Order


order.domain.name


Musí uvádět doménu.

příklad:
order.domain.name: ovh.cz

order.domain.command


Musí uvádět typ objednávy domény: create, Převod nebo Obnovení.

příklad:
order.domain.command: create

order.hosting.type


Musí uvádět typ hostingu: none pro žádný, 90plan, 720plan, mediaplan nebo xxlplan.

příklad:
order.hosting.type: xxlplan

order.offer


Musí být uveden typ doménové nabídky: gold, platinum nebo diamond.

příklad:
order.offer: diamond

order.resellerProfile


Musí být zadán typ prodejce: none pro žádný, whiteLabel pour marque blanche et agent pour agent.

příklad:
order.resellerProfile: none






Kontakt


Tato část definuje kontakty domény:
  • vlastník (owner),
  • administrátor (admin),
  • technický (tech),
  • a fakturační (billing).

contact.owner.id


vlastníka můžete definovat zadáním příslušného NIC-Handle.

příklad:
contact.owner.id: XXXXXX-OVH


contact.owner.name
contact.owner.firstname
contact.owner.legalform
contact.owner.organisation
contact.owner.address
contact.owner.zip
contact.owner.city
contact.owner.country
contact.owner.phone
contact.owner.fax
contact.owner.email
contact.owner.language
contact.owner.vat


Definovat vlastníka lze zadáním všech informací.

příklad:
                            contact.owner.name: MePrijmeni contact.owner.firstname: MeJmeno contact.owner.legalform: FyzickaOsoba contact.owner.organisation: OVH contact.owner.address: Václavské náměstí 807/64 
contact.owner.city: Praha
contact.owner.zip: 11000 contact.owner.country: CR contact.owner.phone: +420.123456789 contact.owner.fax: 
contact.owner.email: podpora@ovh.cz contact.owner.language: CZ contact.owner.vat:
                            

contact.admin.*
contact.tech.*
contact.billing.*


Systém je stejný jako pro ostatní kontakty.






Lze objednat


option.identification.method
option.identification.legalName
option.identification.legalNumber
option.identification.afnicIdent
option.identification.birthDate
option.identification.birthCity
option.identification.birthDepartement
option.identification.birthCountry


Tato sekce je povinná pro vytvoření a převod domén .fr

příklad:
                            option.identification.method: birthPlace option.identification.legalName: OVH option.identification.legalNumber: 123456789 option.identification.afnicIdent: option.identification.birthDate: XX/XX/2009 option.identification.birthCity: MaVille option.identification.birthDepartement: 59 option.identification.birthCountry: FR
                            


option.dns.master
option.dns.slave1
option.dns.slave2
option.dns.slave3
option.dns.slave4
option.dns.slave5


Tato sekce Vám umožní definovat DNS pro vytvoření či převod domény.

příklad:
                            option.dns.master: dns12.ovh.net option.dns.slave1: ns12.ovh.net option.dns.slave2: option.dns.slave3: option.dns.slave4: option.dns.slave5:
                            


option.owo


Tato sekce Vám umožní aktivovat OwO (skrytí některých dat v databázi Whois) k doménám .com, .net, .org, .info, .biz.

příklad:
                            option.owo: yes
                            


option.domain.authinfo


Tato sekce Vám umožní zadt authinfo, kód nezbytný k převodům domén gTld (.com, .net, .org, .info, .biz) et .pl

příklad:
                            option.domain.authinfo: XXXXXXXXXXXXXXX
                            






Soapi


soapi.method
soapi.param.*


Tato sekce umožňuje jednoduše volat funkce SOAPI soapi.method název použité metody, prefix soapi.param. umožňuje definovat všechny parametry předávané funkci.

příklad:
                            soapi.method: zoneEntryAdd soapi.param.domain: ovh.com soapi.param.subdomain: sousdmaines soapi.param.fieldtype: A soapi.param.target: 127.0.0.1