Sobre
Técnica
Operações

SOAPI OVH


Descubra o API OVH baseado SOAP e WSDL. Clique aqui.



O que é isto?

O serviço de PRÉ-PAGAMENTO é um meio de utilizar os pontos que acumulou ou comprou na sua conta fidelidade ou revendedor.
O sistema de base no sistema de encomenda clássico, ou no sistema especializado para a automatização das encomendas.
100 pontos na sua conta equivalem a 1€ s/IVA.



Preço

Um ponto na sua conta, equivale a um cêntimo de euro s/IVA.
Para comprar pontos, deve pagar o IVA ao qual está submetido.




Utilizar pontos :

Pode pagar notas de encomenda criadas com o sistema especializado ou nota de encomenda realizadas com o procedimento clássico.
Com a regra "100 pontos = 1 euro s/IVA" , pode saber com facilidade quantos pontos são necessários para pagar a sua nota de encomenda.

Por exemplo : tenho uma nota de encomenda para um servidor dedicado de 136,15 s/IVA (167,46€ c/IVA ) . Posso pagá-lo com 13 615 pontos a partir da minha conta.



Revendedores :

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.

Automatização por batch-mail


Este sistema permite-lhe converter os seus pontos em encomendas e efectuar operações nos seus serviços.

O processo de conversão faz-se pelo envio de um email formatado para o endereço batch@ovh.com, ou pela utilização de SOAPI. Este email deverá corresponder a uma sintaxe definida abaixo e ser autenticado por um dos métodos seguintes : password. assinatura MD5, PGP ou SMIME.

Sinóptica a seguir :
  • 1. crie a sua encomenda/operação seguindo a sintaxe definida abaixo
  • 2. autentifique a sua encomenda por um dos métodos seguintes : password, assinatura MD5, PGP ou SMIME
  • 3. envie a sua encomenda/operação por mail à batch@ovh.com
    (utilize batch-test@ovh.com se deseja efectuar um teste)

Para criar o seu email, eis as regras a respeitar :
  • O sistema de pré-pagamento aceita apenas os emails formatados e enviados em text/plian para batch@ovh.com
  • Se utiliza a autenticação MD5, as assinaturas devem ser adicionadas ao fim do email em text/plain.
  • Não adicione anexos.

Não hesite em utilizar o endereço batch-test@ovh.com que lhe permite simular a encomenda/operação e então familiarizar-se com o sistema de emails.

Um assistente de gerador de batch-mail está a sua disposição no Espaço cliente , secção Administração > Espaço fidelidade/revendedor > Ferramentas de automatização.






Lista de comandos/operações disponíveis


Criação de um domínio / Repatriamento de um domínio

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






Renovação de um domínio

                    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
                        
                      






Chamada em função SOAPI : Mudanças dos DNS de um domínio

                        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
                        
                      






Explicação dos métodos de autenticação




Assinatura em MD5


É um método que tem por base o calculo do hash MD5 do email que envia e da passphrase que introduziu no manager. Para utilizar este método basta-lhe :
  • indicar que deseja utilizar o método MD5
    batch.auth.method: md5
  • calcular o hash em MD5 de este email. Pode utilizar um dos scripts, em perl ou em PHP, fornecidos abaixo

  • adicionar no fim do email o hash
    batch.auth.md5: 9b02cb2890ce787fdfeef72473a7a149

Script de geração do MD5 em 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;
                                  
                                  


Script de geração do MD5 em 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" ;
                         ?>
                                  
                                  



Painel das secções obrigatórias ou opcionais


As secções obrigatórias estão indicadas por um e as secções opcionais estão anotadas 'opção'.

create transfer renew soapi
batch
order
contacto
opção opção opção
soapi






Conversão dos pontos em uma encomenda de domínio


Batch


batch.version


Deve indicar o número de versão.

exemplo:
batch.version: 4.0

batch.account


Deve indicar o NIC Handle da nota de encomenda. Se utiliza a conta pré-paga, as operações são efectuadas nesse NIC Handle.

exemplo:
batch.account: XXXXXX-OVH

batch.referer


Pode indicar uma referência para identificar o seu pedido.

exemplo:
batch.referer: ma-ref-123456

batch.type


Deve indicar o tipo do pedido, os valores possíveis são 'orderDomain' para uma criação, repatriação ou transferência de um domínio, e 'soapi' para um pedido via SOAPI.

exemplo:
batch.type: orderDomain

batch.auth.method


O tipo de método de autenticação : md5, pgp, smime ou plain. Para mais informações sobre os métodos de autenticação, consulte a página técnica do serviço de pré-pagamento.

exemplo:
batch.auth.method: md5

batch.autopayment


Deve indicar se a nota de encomenda deve ser paga com a conta pré-paga.

exemplo:
batch.autopayment: yes






Order


order.domain.name


Deve indicar o nome do domínio.

exemplo:
order.domain.name: ovh.com

order.domain.command


Deve indicar o tipo da encomenda para o nome de domínio : create, transfer ou renew.

exemplo:
order.domain.command: create

order.hosting.type


Deve indicar o tipo de alojamento : none para nenhum, 90plan, 720plan, mediaplan ou xxlplan.

exemplo:
order.hosting.type: xxlplan

order.offer


É preciso indicar o tipo de oferta para o nome de domínio : gold, platine ou diamond.

exemplo:
order.offer: diamond

order.resellerProfile


Deve indicar o tipo de revendedor : none para nenhum, whiteLabel para marca branca e agente para agente.

exemplo:
order.resellerProfile: none






Contacto


Esta secção define os contactos do domínio :
  • proprietário (owner),
  • administrador (admin),
  • técnico (tech),
  • e facturação (billing).

contact.owner.id


permite-lhe definir o proprietário indicando um nichandle.

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


Permite-lhe definir o proprietário indicando todas as informações.

exemplo:
                            contact.owner.name: MonNom contact.owner.firstname: MonPrénom contact.owner.legalform: individual contact.owner.organisation: OVH contact.owner.address: 140 Quai du Sartel contact.owner.city: Roubaix contact.owner.zip: 59100 contact.owner.country: FR contact.owner.phone: +33.123456789 contact.owner.fax: contact.owner.email: support@ovh.net contact.owner.language: fr contact.owner.vat:
                            

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


O sistema é idêntico para os outros contactos.






Opção


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


Esta secção é obrigatória para a criação e o repatriamento do domínio em .fr .

exemplo:
                            option.identification.method: birthPlace option.identification.legalName: OVH option.identification.legalNumber: 123456789 option.identification.afnicIdent: option.identification.birthDate: XX/XX/2009 option.identification.birthCity: MinhaLocalidade 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


Esta secção permite-lhe definir os dns à utilizar para la criação ou o repatriamento de um nome de domínio.

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


Esta secção permite-lhe activar o OwO (protecção dos dados no Whois) para os seus domínios em .com, .net, .org, .info, .biz.

exemplo:
                            option.owo: yes
                            


option.domain.authinfo


Esta secção permite-lhe indicar o código authinfo obrigatório para as transferências dos domínios gTlds (.com, .net, .org, .info, .biz) e .pl .

exemplo:
                            option.domain.authinfo: XXXXXXXXXXXXXXX
                            






Soapi


soapi.method
soapi.param.*


Esta secção permite-lha chamar simplesmente funções SOAPI. soapi.method indique o nome do método a utilizar, o prefixo soapi.param. permite definir todos os parâmetros à dar a função.

exemplo:
                            soapi.method: zoneEntryAdd soapi.param.domain: ovh.com soapi.param.subdomain: subdominios soapi.param.fieldtype: A soapi.param.target: 127.0.0.1