Getting started with the OVHcloud Connectivity API
Objective
This guide is designed to help developers use our APIs to create their own applications.
Requirements
Instructions
Internet offers
OVHcloud offers various Internet access packages that contain at least one Internet access but also VoIP lines, emails and domain names.
View the OVHcloud Internet access offers.
Services can be managed using these API endpoints:
/pack/xdsl: Manage Internet package offerings./xdsl: Manage Internet access, sub-services and options./connectivity: will replace /xdsl. For now it allows you to check eligibility for copper and fibre offers.
Eligibility
Overview
Eligibility methods are available on the endpoint path /connectivity/eligibility/.
The objective of eligibility is to return eligible Internet offers for a given endpoint (delivery point), so you can order this offer.
An endpoint can be an existing address or line, identified by the line number and its status (active or inactive).
Methods return an asynchronous xdsl.AsyncTask structure, such as:
{
"status": a string, the status of the task ("pending", "done" or "error")
"result": an object, in case of success, the method result
"error": a string, the error message in case of an error
}
Here is an example of a pending task:
{
"status": "pending",
"result": null,
"error": null
}
A successful example task:
{
"status": "success",
"result": { "some key": "some value"},
"error": null
}
And finally an example of a failed task:
{
"status": "error",
"result": null,
"error": "The action failed, here's why"
}
Info
You should check the status of the task, and try again a few seconds later if the task is still in the "pending" status.
Finding the endpoints
For a copper line, the endpoint is a line identified by its number and status.
If no line exists, you will need to test by address to see if you are eligible to create a neighbouring line.
For fibre, the endpoint can be identified by a building identifier, or an OTP (Optical Termination Point) identifier.
An address is identified by a street number and a street code.
To find them, use this process:
- Get the list of localities from a zip code
- Get the list of streets for a locality
- Get the available street numbers for a given street code
- Get the list of buildings for an address
- Get the list of buildings for a specific line
Getting a list of localities from a zip code
Example: we want to search the localities for the zipCode "91400".
The request:
with the following data:
The response:
{
"error": null,
"result": [
{
"inseeCode": "91471",
"zipCode": "91400",
"locality": "ORSAY",
"city": "ORSAY"
},
{
"inseeCode": "91471",
"zipCode": "91400",
"locality": "ORSIGNY",
"city": "ORSAY"
},
{
"inseeCode": "91534",
"zipCode": "91400",
"locality": "SACLAY",
"city": "SACLAY"
}
],
"status": "ok"
}
Getting the list of streets for a locality
Example: We want to obtain the list of streets of the locality "ORSAY" identified by the INSEE code "91471".
The request:
with the following data:
The response:
{
"result": [
{
"streetName": "ALLEE ALFRED POHU",
"streetCode": "9147134101"
},
{
"streetCode": "9147132200",
"streetName": "RUE DU VERGER"
},
{
"streetName": "RUE ELISA DESJOBERT",
"streetCode": "9147111200"
},
{
"streetName": "RUE ETIENNE BAUER",
"streetCode": "9147102180"
},
{
"streetName": "RUE FACULTE D ORSAY",
"streetCode": "9147110752"
}
],
"status": "ok",
"error": null
}
Getting the available street numbers for a given street code
Example: we want the street numbers for the street "RUE DU VERGER" identified by the streetCode "9147132200".
The request:
with the following data:
{
"streetCode": "9147132200"
}
The response:
{
"status": "ok",
"result": [
"1",
"1B",
"2",
"2B",
"3",
"5",
"6",
"7",
"9",
"10",
"11",
"13",
"15",
"17",
"19"
],
"error": null
}
Getting all buildings for a specific address
Example: we want the list of buildings for the address "2 RUE DU VERGER, 91400 ORSAY", identified by streetCode "9147132200" and streetNumber "2".
The request:
with the following data:
{
"streetCode": "9147132200",
"streetNumber": "2"
}
The response:
{
"status": "ok",
"error": null,
"result": [
{
"stairs": [],
"reference": "IMB/91471/C/NT8X",
"type": "HOUSE",
"name": "",
"nro": "91122BUR"
}
]
}
Getting the building references from a given line number
Example: we want the list of buildings for the inactive line number "0123456789".
The request:
with the following data:
{
"lineNumber": "0123456789",
"status": "inactive"
}
The response:
{
"error": null,
"result": [
{
"nro": "91122BUR",
"name": "",
"stairs": [],
"type": "HOUSE",
"reference": "IMB/91471/C/NT8X"
}
],
"status": "ok"
}
We found a single building that is a house.
Doing a copper eligibility (ADSL or VDSL)
Possible cases are:
Doing an eligibility on a line
If you know the number and status of the line then you can check its eligibility.
The difference between an active and an inactive line is that an active line has an active Internet access, whereas the inactive line is just an identifier to use to order an Internet access (usually this is the previous number of the last owner, who moved with his line).
Warning
It is important to distinguish an active line from an inactive line. Always verify that the address returned is the actual address of the installation.
Here is the request:
to do with the following POST data:
{
"lineNumber": "0123456789",
"status": "active"
}
Here is a partial successful response example:
{
"status": "ok",
"error": null,
"result": {
"offers": [
{
"eligibility": {
"reasons": [
{
"message": "Copper not currently available in this area.",
"code": "COPPER_NOT_YET_AVAILABLE",
"availabilityDate": null
}
],
"estimatedUploadRate": 1,
"activationTypes": [
"activate"
],
"eligible": false,
"estimatedDownloadRate": 8.17,
"underConditions": []
},
"product": {
"uploadRate": 1,
"pairs": 1,
"downloadRate": 20,
"name": "ADSL-Max with shared unbundling",
"provider": "KOSC",
"code": "ADSL-MAX_SHARED",
"guaranteed": false,
"type": "ADSL",
"grt": []
}
},
{
"product": {
"guaranteed": false,
"type": "VDSL",
"grt": [],
"pairs": 1,
"uploadRate": 1,
"provider": "KOSC",
"code": "VDSL-MAX_FULL",
"name": "VDSL-Max with full unbundling",
"downloadRate": 20
},
"eligibility": {
"estimatedUploadRate": 0,
"reasons": [
{
"code": "TOO_MUCH_ATTENUATION",
"message": "Too much attenuation to deliver the product.",
"availabilityDate": null
}
],
"underConditions": [],
"estimatedDownloadRate": 0,
"eligible": false,
"activationTypes": [
"activate",
"create"
]
}
},
{
"eligibility": {
"estimatedUploadRate": 0.9970703125,
"reasons": [],
"underConditions": [],
"estimatedDownloadRate": 8.173828125,
"activationTypes": [
"create",
"activate"
],
"eligible": true
},
"product": {
"name": "ADSL-Max full unbundling",
"downloadRate": 20,
"provider": "KOSC",
"code": "ADSL-MAX_FULL",
"uploadRate": 1,
"pairs": 1,
"grt": [],
"type": "ADSL",
"guaranteed": false
}
},
{
"eligibility": {
"activationTypes": [
"activate"
],
"eligible": false,
"estimatedDownloadRate": 0,
"underConditions": [],
"reasons": [
{
"message": "Too much attenuation to deliver the product.",
"code": "TOO_MUCH_ATTENUATION",
"availabilityDate": null
}
],
"estimatedUploadRate": 0
},
"product": {
"code": "VDSL-MAX_SHARED",
"provider": "KOSC",
"downloadRate": 20,
"name": "VDSL-Max with shared unbundling",
"pairs": 1,
"uploadRate": 1,
"type": "VDSL",
"grt": [],
"guaranteed": false
}
}
],
"endpoint": {
"portability": {
"type": null,
"eligibility": {
"underConditions": [],
"eligible": false,
"reasons": [
{
"availabilityDate": null,
"code": "3049",
"message": "L opérateur détient le parc à modifier"
}
]
},
"quarantineEndDate": null
},
"referenceType": "lineNumber",
"fiberInfo": null,
"copperInfo": {
"sectionsLengths": [
{
"diameter": 4,
"length": 3010
}
],
"maxAvailablePairs": 1,
"status": "active",
"underConstruction": false,
"unlistedNumber": false,
"availablePairs": 1,
"nra": "90123ABC"
},
"reference": "0123456789",
"address": {
"door": "00002",
"city": "PARIS",
"floor": null,
"stairs": null,
"streetName": "RUE DES JARDINS",
"housingComplex": "",
"zipCode": "94123",
"building": null,
"streetCode": "9412301234",
"streetNumber": "4",
"ownerName": null,
"inseeCode": "94321"
}
},
"eligibilityReference": "abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz01"
}
}
The response is composed of:
- a result.offers table that will list all the offers and if the given line is eligible or not;
- a result.endpoint structure that gives line information: address and characteristics.
Here is a description of the offer codes:
Searching for an active or inactive line for an address
The request:
with the following POST data:
{
"streetCode": "123456789",
"streetNumber": "2"
}
The response:
{
"status": "ok",
"error": null,
"result": [
{
"copperInfo": {
"underConstruction": null,
"availablePairs": null,
"status": "inactive",
"unlistedNumber": false,
"maxAvailablePairs": null,
"nra": null,
"sectionsLengths": []
},
"address": {
"streetCode": "123456789",
"stairs": null,
"floor": null,
"city": "ROUBAIX",
"door": null,
"streetName": "RUE DES JARDINS",
"zipCode": "94123",
"building": null,
"housingComplex": "",
"inseeCode": "94123",
"streetNumber": "4",
"ownerName": "J*** D**"
},
"lineNumber": "0123456789"
}
]
}
For this address we found a single inactive line with the number 0123456789.
You can now use the eligibility by line.
Info
Unlisted numbers cannot be retrieved using this method.
Searching for eligibility for an address
This will return an eligibility by address, to be used for the creation of a neighbouring line.
A neighbouring line creation consists in checking the availability of new copper lines by searching for your nearest neighbour line information.
Info
If you already have an active or inactive line, you should use the line test instead.
The request:
with the following data:
{
"streetCode": "94123001234",
"streetNumber": "4"
}
The response:
{
"status": "ok",
"result": {
"eligibilityReference": "abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz01",
"endpoint": {
"referenceType": "lineNumber",
"portability": {
"quarantineEndDate": null,
"type": null,
"eligibility": {
"underConditions": [],
"reasons": [],
"eligible": false
}
},
"address": {
"city": "PARIS",
"zipCode": "94123",
"stairs": null,
"door": null,
"streetCode": "94123001234",
"inseeCode": "94123",
"ownerName": null,
"streetName": "RUE DES JARDINS",
"housingComplex": "",
"building": null,
"floor": null,
"streetNumber": "4"
},
"fiberInfo": null,
"copperInfo": {
"sectionsLengths": [
{
"diameter": 4,
"length": 1239
}
],
"underConstruction": false,
"maxAvailablePairs": 6,
"unlistedNumber": false,
"nra": "59512PIL",
"availablePairs": 6,
"status": "active"
},
"reference": "0123456789"
},
"offers": [
{
"eligibility": {
"activationTypes": [
"createNeighbour"
],
"estimatedDownloadRate": 20.04,
"underConditions": [],
"reasons": [
{
"message": "Too much attenuation to deliver the product.",
"availabilityDate": null,
"code": "TOO_MUCH_ATTENUATION"
}
],
"eligible": false,
"estimatedUploadRate": 1.48
},
"product": {
"provider": "KOSC",
"downloadRate": 20,
"pairs": 1,
"name": "VDSL-Max with full unbundling",
"uploadRate": 1,
"guaranteed": false,
"type": "VDSL",
"grt": [],
"code": "VDSL-MAX_FULL"
}
},
{
"product": {
"provider": "KOSC",
"pairs": 1,
"downloadRate": 20,
"name": "ADSL-Max full unbundling",
"uploadRate": 1,
"guaranteed": false,
"type": "ADSL",
"code": "ADSL-MAX_FULL",
"grt": []
},
"eligibility": {
"eligible": true,
"estimatedUploadRate": 1.16796875,
"underConditions": [],
"reasons": [],
"estimatedDownloadRate": 18.935546875,
"activationTypes": [
"createNeighbour"
]
}
}
]
},
"error": null
}
Checking fibre eligibility (FTTH)
For fibre eligibility, we have two scenarios:
- I have an Optical Termination Point (OTP) fibre ID, which I will use for eligibility;
- I do not have an OTP fibre identifier and will use a building identifier for the eligibility.
A building can be a house or a building with multiple housing. The building can be found from an address or from an existing copper line.
The eligibility process from an address is as follows:
- Getting the list of localities from a zip code
- Getting the list of streets for a locality
- Getting the available street numbers for a given street code
- Getting all buildings for a specific address
- Searching eligibility for the selected building
From one line, we have to:
- Get the building references from a given line number
- Search eligibility for the selected building
For an OTP, this is the simplest:
- Doing the eligibility test for the OTP
Here are the details for each type of requests.
Searching eligibility on a building
Example: we want to check the eligibility of FTTH offers for the building identified by the reference "IMB/91471/C/NT8X".
The request:
with the following data:
{
"building": "IMB/91471/C/NT8X"
}
The response:
{
"error": null,
"status": "ok",
"result": {
"offers": [
{
"product": {
"pairs": null,
"uploadRate": 800,
"guaranteed": false,
"code": "PROFIBER",
"type": "FTTH",
"grt": [],
"name": "PRO FIBER with 1G download and 800M upload",
"provider": "KOSC",
"downloadRate": 1000
},
"eligibility": {
"estimatedDownloadRate": null,
"estimatedUploadRate": null,
"underConditions": [],
"activationTypes": [],
"reasons": [],
"eligible": true
}
}
],
"endpoint": {
"referenceType": "building",
"portability": null,
"address": {
"door": null,
"floor": null,
"stairs": null,
"zipCode": "91400",
"city": "ORSAY",
"streetNumber": "2",
"housingComplex": null,
"inseeCode": "91471",
"ownerName": null,
"streetName": "RUE DU VERGER",
"building": null,
"streetCode": "9147123456"
},
"fiberInfo": {
"nro": "91122ABC",
"operatorCode": "FI",
"buildingType": "HOUSE",
"buildingName": "",
"buildingReference": "IMB/91234/A/NT6Z",
"operatorName": "ORANGE"
},
"reference": "IMB/91234/A/NT6Z",
"copperInfo": null
},
"eligibilityReference": "abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqrstuvwxyz01"
}
}
In the result for the "offers" table, the boolean attribute eligibility.eligible tells us we are eligible for "PRO FIBER with 1G download and 800M upload" offer.
Searching eligibility from an OTP identifier
Example: we want to check FTTH offers eligibility for the OTP "OO-XXXX-XXXX/C".
The request:
with the following data:
{
"otp": "OO-XXXX-XXXX/C"
}
The response is the same as in the previous example.
Go further
Join our community of users.
