Über
Technisch
Operationen

OVH SOAPI


Entdecken Sie die API von OVH, die auf SOAP und WSDL basiert. Klicken Sie hier.



Was ist das?

Mit der Dienstleistung Prepayment können Sie die Punkte, die Sie in Ihrem Treue- oder Reselleraccount angesammelt oder gekauft haben, nutzen.
Das System funktioniert mit dem klassischen Bestellsystem oder mit einem System, das auf die Automatisierung der Bestellungen spezialisiert ist.
100 Punkte auf Ihrem Konto entsprechen 1 Euro ohne MwSt.



Tarife

1 Punkt auf Ihrem Konto entsprechen 0,01 Euro ohne MwSt.
Um Punkte zu kaufen, müssen Sie Mehrwertsteuer bezahlen, sofern Sie mehrwertsteuerpflichtig sind.




Punkte benutzen:

Sie können Bestellungen, die mit dem spezialisierten System oder dem klassischen Bestellsystem erstellt wurden, bezahlen.
Anhand der Regel "100 Punkte = 1 Euro ohne MwSt." kann man leicht feststellen, wie viele Punkte notwendig sind, um einen Bestellschein zu begleichen.

Zum Beispiel: Ich habe einen Bestellschein für einen Server von 162,02 € . Dann kann ich diesen mit 13 615 Punkten von meinem Punktekonto bezahlen.



Reseller:

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.

Automatisierung per Batch-Mail


Dieses System erlaubt es Ihnen, Ihre Treuepunkte in Bestellungen zu konvertieren und Operationen in Zusammenhang mit Ihren Dienstleistungen durchzuführen.

Der Konvertierungsprozess erfolgt durch den Versand einer formatierten E-Mail an die Adresse batch@ovh.comoder die Verwendung von SOAPI. Diese Mail muss der weiter unten definierten Syntax entsprechen und anhand der folgenden Methoden authentifiziert werden: Passwort, MD5 Signatur, PGP oder SMIME.

Vorgehensweise für die Batchmail Nutzung:
  • 1. Erstellen Sie Ihre Bestellung/Operation unter Berücksichtigung der weiter unten definierten Syntax
  • 2. Authentifizieren Sie Ihre Bestellung anhand einer der folgenden Methoden: Passwort, MD5 Signatur, PGP oder SMIME
  • 3. Senden Sie Ihre Bestellung/Operation per E-Mail an batch@ovh.com
    (verwenden Sie batch-test@ovh.com wenn Sie einen Test durchführen wollen)

Bei der Erstellung Ihrer Mail muss folgendes beachtet werden:
  • Das Prepaid-System kann nur mit Mails umgehen, die als Text/Plain formatiert sind und an folgende Adresse versandt werden: batch@ovh.com
  • Wenn Sie die MD5 Authentifizierung verwenden, dann müssen die Signaturen am Ende der Mail als Text/Plain eingefügt werden.
  • Fügen Sie keine Anhänge an die E-Mail an.

Zögern Sie nicht, die Adresse batch-test@ovh.com zu verwenden: diese erlaubt es Ihnen, die Bestellungen/Operationen zu simulieren, um sich in Ruhe mit dem Batchmailsystem vertraut machen zu können.

Ein Assistent für die Generierung der Batch-Mail steht Ihnen im Managerzur Verfügung, und zwar unter Verwaltung > Treuebereich > Automatisierungswerkzeuge.






Liste der verfügbaren Befehle und Operationen


Erstellung einer Domain / Transfer einer Domain

                    ## 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
                        
                      






Verlängerung einer Domain

                    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
                        
                      






Aufruf einer SOAPI Funktion: Änderung der DNS einer Domain

                        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
                        
                      






Vorstellung der verfügbaren Authentifizierungsmethoden




MD5 Signatur


Diese Methode basiert auf der Berechnung des MD5 Hashs der E-Mail und der Passphrase, die Sie im Manager angegeben haben. Um diese Methode zu verwenden genügt es:
  • Geben Sie an, dass Sie MD5 als Methode verwenden möchten
    batch.auth.method: md5
  • Den MD5 Hash dieser E-Mail berechnen. Sie können dazu eines der unten aufgeführten Perl oder PHP Skripte verwenden

  • Den Hash am Ende der E-Mail einfügen
    batch.auth.md5: 9b02cb2890ce787fdfeef72473a7a149

Perl Skript für die Generierung des MD5

                         #!/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;
                                  
                                  


PHP Skript für die Generierung des MD5

                         <?
                         // 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" ;
                         ?>
                                  
                                  



Tabelle der obligatorischen und optionalen Rubriken


Die obligatorischen Rubriken werden mit einem gekennzeichnet und die optionalen Rubriken als 'Option'.

create Transfer Renew soapi
batch
order
contact
Option Option Option
soapi






Konvertierung der Punkte in eine Domainbestellung


Batch


batch.version


Es muss die Versionsnummer angegeben werden.

Beispiel:
batch.version: 4.0

batch.account


Es muss die Kundenkennung des Bestellscheins angegeben werden. Wenn Sie den Prepaid-Account verwenden, dann werden die Operationen unter dieser Kennung ausgeführt.

Beispiel:
batch.account: XXXXXX-OVH

batch.referer


Sie können eine Referenz angeben, um Ihre Anfrage identifizieren zu können.

Beispiel:
batch.referer: meine-referenz-123456

batch.type


Es muss der Typ der Anfrage angegeben werden, mögliche Werte sind 'orderDomain' für die Erstellung oder den Transfer einer Domain, und 'soapi' für eine über das SOAPI durchgeführte Anfrage.

Beispiel:
batch.type: orderDomain

batch.auth.method


Die verwendete Authentifizierungsmethode: MD5, PGP, S/MIME oder Plain. Mehr Informationen zu den Authentifizierungsmethoden erhalten Sie auf der Seite mit den technischen Details zum Prepaid-Dienst.

Beispiel:
batch.auth.method: md5

batch.autopayment


Es muss angegeben werden, ob der Bestellschein unter Verwendung des Prepaid-Accounts beglichen werden soll.

Beispiel:
batch.autopayment: yes






Bestellung


order.domain.name


Es muss der Domainname angegeben werden.

Beispiel:
order.domain.name: ovh.com

order.domain.command


Es muss der Typ der Bestellung für den Domainnamen angegeben werden: create, Transfer oder Renew.

Beispiel:
order.domain.command: Create

order.hosting.type


Es muss der Typ des Hostings angegeben werden: none Für "kein Hosting" 90plan, 720plan, mediaplan oder xxlplan.

Beispiel:
order.hosting.type: xxlplan

order.offer


Der Typ des Angebots für den Domainnamen muss angegeben werden: Gold, Platin oder Diamond.

Beispiel:
order.offer: diamond

order.resellerProfile


Es muss der Typ des Resellers angegeben werden: none Für "kein Hosting" whiteLabel für "Weisse Marke" und Agent für "Agent".

Beispiel:
order.resellerProfile: None






Kontakt


Diese Rubrik definiert die Kontakte der Domain:
  • Inhaber (owner),
  • Administrator (admin),
  • Technisch (tech),
  • und Rechnung (billing).

contact.owner.id


erlaubt es Ihnen, den Inhaber zu definieren, indem Sie dessen Kundenkennung angeben.

Beispiel:
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


erlaubt es Ihnen, den Inhaber zu definieren, indem Sie dessen vollständige Kontaktinformationen angeben.

Beispiel:
                            contact.owner.name: MeinName contact.owner.firstname: MeinVorname contact.owner.legalform: Privatperson contact.owner.organisation: OVH contact.owner.address: Dudweiler Landstraße 5 contact.owner.city: Saarbrücken contact.owner.zip: 66123 contact.owner.country: DE contact.owner.phone: +49.681906730 contact.owner.fax: contact.owner.email: kundendienst@ovh.de contact.owner.language: de contact.owner.vat:
                            

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


Das System funktioniert für die anderen Kontakte auf die gleiche Art und Weise.






Option


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


Diese Rubrik ist für die Erstellung und den Transfer von .fr Domains erforderlich.

Beispiel:
                            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


Diese Rubrik erlaubt es Ihnen, die für die Erstellung oder den Transfer von Domains zu verwendenden DNS zu definieren.

Beispiel:
                            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


Diese Rubrik erlaubt es Ihnen, den OwO Dienst (Verschleierung der Daten im Whois) für damit kompatible Domains (z.B. .com, .net, .org, .info...) zu aktivieren

Beispiel:
                            option.owo: yes
                            


option.domain.authinfo


Diese Rubrik erlaubt es Ihnen, den für den Transfer bestimmter Domains (z.B. .com, .net, .org, .info...) erforderlichen AuthInfo Code anzugeben.

Beispiel:
                            option.domain.authinfo: XXXXXXXXXXXXXXX
                            






SOAPI


soapi.method
soapi.param.*


Diese Rubrik erlaubt es, SOAPI Funktionen ganz einfach aufzurufen. soapi.method Gibt den Namen der zu verwendenden Methode an - den Präfix soapi.param. erlaubt es, alle der Funktion zu übergebenden Parameter zu definieren.

Beispiel:
                            soapi.method: zoneEntryAdd soapi.param.domain: ovh.com soapi.param.subdomain: subdomains soapi.param.fieldtype: A soapi.param.target: 127.0.0.1