Acerca de...
Técnico
Operaciones

SOAPI OVH


Descubra la API de OVH basada en SOAP y WSDL. Haga clic aquí.



¿Cómo funciona?

El servicio de prepago es una forma de utilizar los puntos acumulados o adquiridos en la cuenta de fidelidad o de revendedor.
Los puntos pueden utilizarse en el marco del sistema de pedidos tradicional o para la automatización de los pedidos.
100 puntos de la cuenta equivalen a 1 €.



Precios

Un punto de la cuenta equivale a un céntimo de euro del precio sin IVA.
Por lo tanto, al comprar puntos deberá pagar el IVA al que esté obligado.




Utilización de puntos

Los puntos pueden utilizarse para abonar pedidos realizados con el sistema de revendedor en la API o desde la página web con el sistema tradicional.
Siguiendo la regla «100 puntos = 1 euro + IVA», puede calcular fácilmente cuántos puntos necesitará para abonar su orden de pedido.

Por ejemplo, si tiene una orden de pedido para un servidor dedicado de 136,15 € + IVA (164,74 €  IVA incl.) , puede abonarla con 13.615 puntos de su cuenta de fidelidad, puesto que ya pagó el IVA correspondiente al adquirir los puntos.



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.

Automatización por batchmail


Este sistema permite convertir los puntos en pedidos y realizar operaciones en los servicios.

El proceso de conversión se realiza enviando un email formateado a la dirección batch@ovh.com o mediante SOAPI. Dicho email deberá corresponder a la sintaxis que se indica más adelante, y deberá autentificarse mediante uno de los siguientes métodos: contraseña, firma MD5, PGP o SMIME.

Esquema a seguir:
  • 1. Cree su pedido u operación con la sintaxis qeu se indica más adelante.
  • 2. Autentifique su pedido con uno de los siguientes métodos: contraseña, firma MD5, PGP o SMIME.
  • 3. Envíe su pedido u operación por correo electrónico a batch@ovh.com
    (utilice batch-test@ovh.com si quiere realizar una prueba).

Para crear su email, deberá respetar las siguientes reglas:
  • El sistema de prepago solo acepta los emails formateados y enviados en modo de texto plano a batch@ovh.com
  • Si utiliza la autentificación MD5, las firmas deben añadirse al final del email en texto plano.
  • No adjunte archivos.

No dude en utilizar la dirección batch-test@ovh.com para simular el pedido u operación y así poder familiarizarse con el sistema de correo electrónico.

Un asistente generador de batchmail está a su disposición en el área de cliente, en Administración > Espacio fidelidad/revendedor > Herramientas de automatización.






Lista de comandos y operaciones disponibles


Creación/Transferencia de un dominio

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






Renovación de un dominio

                    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
                        
                      






Llamada a una función SOAPI: cambio de los DNS de un dominio

                        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
                        
                      






Explicación de los métodos de autentificación




Firma en MD5


Es un método que se basa en calcular el hash MD5 del email que haya introducido en el manager. Para utilizar este método solo hay que:
  • Indicar que desea utilizar el método MD5:
    batch.auth.method: md5
  • Calcular el hash en MD5 del email. Puede utilizar uno de los scripts de Perl o PHP que se indican a continuación.

  • Añadir el hash al final del email:
    batch.auth.md5: 9b02cb2890ce787fdfeef72473a7a149

Script de generación del MD5 en 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 generación del MD5 en 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" ;
                         ?>
                                  
                                  



Tabla de secciones obligatorias y opcionales


Las secciones obligatorias se indican con y las secciones opcionales están marcadas como 'opcional'.

create transferencia renovación soapi
batch
contratar
contact
opcional opcional opcional
soapi






Convertir puntos en un pedido de dominio


Batch


batch.version


Hay que indicar el número de versión.

Ejemplo:
batch.version: 4.0

batch.account


Hay que indicar el identificador (NIC) del usuario que envía la orden de pedido. Si utiliza una cuenta de prepago, los puntos se descontarán a dicho identificador.

Ejemplo:
batch.account: XXXXXX-OVH

batch.referer


Puede indicar una referencia para identificar la petición.

Ejemplo:
batch.referer: mi-ref-123456

batch.type


Hay que indicar el tipo de petición. Los valores posibles son: 'orderDomain' para una creación o transferencia de dominio y 'soapi' para una petición a través de SOAPI.

Ejemplo:
batch.type: orderDomain

batch.auth.method


El método de autentificación: md5, pgp, smime o plain. Para más información sobre los métodos de autentificación, consulte la página técnica del servicio de prepago.

Ejemplo:
batch.auth.method: md5

batch.autopayment


Hay que indicar si el pedido debe abonarse con puntos de la cuenta de prepago.

Ejemplo:
batch.autopayment: yes






Order


order.domain.name


Hay que indicar el dominio.

Ejemplo:
order.domain.name: ovh.com

order.domain.command


Hay que indicar el tipo de pedido para el dominio: create, transferencia o renovación.

Ejemplo:
order.domain.command: create

order.hosting.type


Hay que indicar el tipo de alojamiento: none para ninguno, 90plan, 720plan, mediaplan o xxlplan.

ejemplo:
order.hosting.type: xxlplan

order.offer


Debe indicar el tipo de producto para el nombre de dominio: Gold, Platine o Diamond.

Ejemplo:
order.offer: diamond

order.resellerProfile


Hay que indicar el tipo de revendedor: none para ninguno, whiteLabel para marca blanca y agente para agente.

Ejemplo:
order.resellerProfile: none






Contacto


Esta sección establece los contactos del dominio:
  • titular (owner),
  • administrador (admin),
  • técnico (tech),
  • y de facturación (billing).

contact.owner.id


Permite establecer el propietario indicando su identificador (NIC).

Ejemplo:
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 establecer el propietario indicando todos sus datos.

Ejemplo:
                            contact.owner.name: MiApellido
contact.owner.firstname: MiNombre
contact.owner.legalform: individual
contact.owner.organisation: OVH
contact.owner.address: C/ Princesa 22, 2º dch.
contact.owner.city: Madrid
contact.owner.zip: 28028
contact.owner.country: ES
contact.owner.phone: +34.912345678
contact.owner.fax:
contact.owner.email: soporte@ovh.es
contact.owner.language: es
contact.owner.vat:
                            

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


El sistema es idéntico para los demás contactos.






Opcional


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 sección es obligatoria para la creación y transferencia de dominios .fr.

Ejemplo:
                            option.identification.method: birthPlace
option.identification.legalName: OVH
option.identification.legalNumber: 123456789
option.identification.afnicIdent:
option.identification.birthDate: XX/XX/2009
option.identification.birthCity: MiLocalidad
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 sección permite indicar los DNS que deben utilizarse para la creación o transferencia de un dominio.

Ejemplo:
                            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 sección permite activar el OWO (protección de datos en el Whois) para los dominios .com, .net, .org, .info y .biz.

Ejemplo:
                            option.owo: yes
                            


option.domain.authinfo


Esta sección permite indicar el código Authinfo obligatorio para las transferencias de dominios gTLD (.com, .net, .org, .info y .biz) y .pl.

Ejemplo:
                            option.domain.authinfo: XXXXXXXXXXXXXXX
                            






Soapi


soapi.method
soapi.param.*


Esta función permite llamar fácilmente a funciones SOAPI. soapi.method indica el nombre del método utilizado, y el prefijo soapi.param. permite indicar los parámetros que queremos pasar a la función.

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