Discover the OVH API based on SOAP and WSDL. Click here.
The PRE-PAYMENT service is a way of using the points that you've earned or bought on your loyalty or reseller account.
The system is based on the usual ordering process or on the specialised order automation system.
100 points on your account is equivalent to £1 excl. VAT.
1 point on your account is equivalent to €0.01.
When purchasing points, VAT is included.
You can pay for your orders in points through the SoAPI system or through the usual ordering process.
With the rule "100 points = £1 VAT Free, you can easily know how many points are needed to pay for your order.
For example: I have an order for a dedicated server €136.15 . I can pay with 13,615 points from my account.
A specific loyalty program is underway. Watch this space for updates.
Automation by batch-mail
This system allows you to convert your order points and perform operations on your services.
The conversion process is done by sending a formatted email to the address email@example.com, or by the use of SOAPI. This email must match the syntax defined below and be authenticated by the following method: password, MD5 signature, PGP or MIME.
Synoptic to follow:
- 1. create your order or operation by following the syntax defined below
- 2. authenticate your order by one of the following methods : password, MD5 signature, PGP or SMIME
- 3. send your order/operation by mail to firstname.lastname@example.org
(use email@example.com if you want to test it)
- The pre-payment system does not include the formatted mail and sent as text/plain on firstname.lastname@example.org
- If you use MD5 authentication, signatures must be added to the end of the email in text/plain.
- Do not add attachment.
Do not hesitate to use the address email@example.com that allows you to simulate the order/operation and therefore familiarise yourself with the mail system.
A batch-mail generator is at your disposal in the Control Panel, Administration > Loyalty/Retailer > Automation Tools section.
Orders/available operations list
Creation of a domain / Transfer of a domain
Renewal of a domain
Calling a SOAPI function: Change domain DNS
Explanation of authentication methods
It is a method that is based on calculating the MD5 hash of the email you send and the passphrase you entered in the manager. When using this method just:
- indicate that you want to use the MD5 method
- calculate the MD5 hash of this email. You can use a script in Perl or PHP, provided below
- add at the end of the email the hash
Script for generation of MD5 in perl
Script for generation of MD5 in PHP
Table of mandatory or optional sections
The mandatory sections are indicated by a and optional sections are noted with 'option'.
Conversion of points in a domain order
You must indicate the version number.
You must indicate the NIC Handle of the purchase order. If you use the prepaid account, the transactions are made on the NIC Handle.
You can specify a reference to indentify your request.
You must indicate the type of application. The possible values are 'orderDomain' for a creation, renewal or transfer of a domain, and 'soapi' for a query using SOAPI.
The types of authentication methods are md5, pgp, smime or plain. For more information on authentication methods, see The pre-payment service technical page .
You should indicate whether the order should be paid using the prepaid account.
You must indicate the domain name.
You must indicate the type of order for the domain name : create, transfer or renew.
You must indicate the type of hosting: none for none, 90plan, 720plan, mediaplan or xxlplan.
Type of domain name offer must be indicated: Gold, Platinum or Diamond.
You must indicate the type of retailer: none for none, whiteLabel for white label and agent for agent.
This section defines the domain contacts:
- owner (owner),
- administrator (admin),
- technical (tech),
- and billing (billing).
allows you to set the owner indicating a nichandle.
Allows you to set the owner indicating all information.
contact.owner.name: MySurname contact.owner.firstname: MonName contact.owner.legalform: individual contact.owner.organisation: OVH contact.owner.address: 5 Fitzwilliam place contact.owner.city: Dublin contact.owner.zip: 00000 contact.owner.country: IE contact.owner.phone: +353.16390037 contact.owner.fax: contact.owner.email: firstname.lastname@example.org contact.owner.language: en contact.owner.vat:
The system is identical for other contacts.
This section is mandatory for the creation and transfer of .fr domains.
option.identification.method: birthPlace option.identification.legalName: OVH option.identification.legalNumber: 123456789 option.identification.afnicIdent: option.identification.birthDate: XX/XX/2009 option.identification.birthCity: MyTown option.identification.birthDepartement: 59 option.identification.birthCountry: IE
This section allows you to set the DNS to operate for the creation or transfer of a domain name.
option.dns.master: dns12.ovh.net option.dns.slave1: ns12.ovh.net option.dns.slave2: option.dns.slave3: option.dns.slave4: option.dns.slave5:
This section allows you to activate OwO (Data Protection in Whois) for .com, .net, .org, .info and .biz domains.
This section allows you to specify the AUTHINFO code required for transfers of gTLD domains (.com, .net, .org, .info, .biz) and .pl .
This section allows you to simply call up SOAPI functions soapi.method indicates the name of the method, the prefix soapi.param. to define all the parameters to pass to the function.
soapi.method: zoneEntryAdd soapi.param.domain: ovh.com soapi.param.subdomain: subdomains soapi.param.fieldtype: A soapi.param.target: 127.0.0.1