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 :
O 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 converter os seus pontos em encomendas e efetuar operações nos seus serviços.
O processo de conversão ocorre através do envio de um e-mail pre-formatado para o endereço batch@ovh.com, ou pela utilização de SOAPI. Este email deverá corresponder à sintaxe definida abaixo e ser autenticado por um dos métodos seguintes: password. assinatura MD5, PGP ou SMIME.
Instruções:
- 1. Crie a sua encomenda/operação seguindo a sintaxe indicada abaixo
- 2. Valide a encomenda com um dos seguintes métodos: password, assinatura MD5, PGP ou SMIME
- 3. Envie a sua encomenda/operação por mail a batch@ovh.com
(utilize batch-test@ovh.com se desejar efetuar um teste)
- O sistema de pré-pagamento aceita apenas os e-mails formatados e enviados em plain text para batch@ovh.com
- Se utiliza a autenticação MD5, as assinaturas devem ser adicionadas no final do email em text/plain.
- Não adicione anexos.
Não hesite em utilizar o endereço batch-test@ovh.com para simular a encomenda/operação e perceber como funciona o sistema de e-mail.
Pode usar o assistente de geração de batch-mail, disponível no Área de Cliente , secção Administração > Espaço fidelidade/revendedor > Ferramentas de automatização.

Lista de comandos/operações disponíveis
Criação de domínio / Transferência de 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 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

Chamar uma função SOAPI: mudança 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
Método baseado no cálculo do hash MD5 do email que pretende enviar, e na passphrase que introduziu no manager. Para utilizar este método basta:
- indicar que deseja utilizar o método MD5
batch.auth.method: md5
- calcular o hash MD5 deste email. Pode utilizar um dos scripts, em perl ou em PHP, fornecidos abaixo
- adicionar o hash no fim do email
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" ; ?>
PGP
Este método está em desenvolvimento.
SMIME
Este método está em desenvolvimento.
Modo plain
Método menos seguro que envia um email com a sua password. No entanto, a OVH aceita as ligações encriptadas (TLS) em SMTP (porta 465), por serem mais seguras.
Para usar este método basta:
- indicar que deseja usar o método plain
batch.auth.method: plain
- O serviço FAX/Atendedor de chamadas:
batch.auth.password: XXXXXX
Painel das secções obrigatórias e opcionais
As secções obrigatórias estão indicadas por um

create | transfer | renew | soapi | |
---|---|---|---|---|
batch | ![]() |
![]() |
![]() |
![]() |
order | ![]() |
![]() |
![]() |
|
contacto | ![]() |
![]() |
||
opção | opção | opção | ||
soapi | ![]() |

Converter pontos numa subscrição 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
Indique o tipo do pedido: selecione 'orderDomain' para uma criação ou transferência de um domínio, e 'soapi' para um pedido via SOAPI.
exemplo:
batch.type: orderDomain
batch.auth.method
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 do serviço de pré-pagamento.
exemplo:
batch.auth.method: md5
batch.autopayment
Deve indicar se irá efetuar o pagamento da nota de encomenda com a conta pré-paga.
exemplo:
batch.autopayment: yes

Order
order.domain.name
Deve indicar o domínio.
exemplo:
order.domain.name: ovh.com
order.domain.command
Deve indicar o tipo da encomenda para o 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 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:
- titular (owner),
- administrador (admin),
- técnico (tech),
- e facturação (billing).
contact.owner.id
permite definir o titular, indicando um Nic Handle (identificador).
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 definir o titular 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 a transferência 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 definir os dados DNS a utilizar para a criação ou transferência de um 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 ativar o OwO (Ocultação de dados no Whois) para os seus domínios .com, .net, .org, .info, .biz.
exemplo:
option.owo: yes
option.domain.authinfo
Esta secção permite 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 chamar 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
