Outil d’éligibilité
- Accueil / API Eurafibre /
- Outil d’éligibilité
Spécifications techniques de l'API Eurafibre : outil d’éligibilité
v1.4 20200515
Présentation
Soucieux d’offrir à ses clients un service toujours plus performant, Eurafibre a développé et mis en place un outil d’éligibilité à son réseau fibre optique sous forme d’API (Application Programmation Interface).
Cette interface, accessible uniquement dans le cadre d’un contrat de partenariat, permet aux clients d’Eurafibre de connaître, à tout moment et en toute autonomie, les conditions d’accès au réseau Eurafibre de n’importe quel site géographique ainsi que les tarifs proposés par Eurafibre.
Fonctionnement
Après avoir encodé une adresse (ou un numéro de SIRET), le client partenaire a la possibilité d’obtenir directement les informations suivantes :
• La zone
• L’éligibilité
• Le débit possible
• Le montant des frais d’accès au service
• Le montant mensuel de la connexion
• La durée minimale d’engagement
Note : dans sa version actuelle, l’API ne permet pas de prise de commande.
Accès
L’utilisation de l’API étant strictement réservée aux clients Eurafibre, il est nécessaire d’utiliser une clé unique et personnelle pour accéder au service. Les clients qui souhaitent utiliser l’outil d’éligibilité doivent simplement en faire la demande auprès de notre service commercial.
Documentation
PARAMÈTRES D'ENTRÉE :
| Paramètre | Valeur | Description |
|---|---|---|
| api_key | clé API | clé API unique du partenaire |
| delivery_express | 0 / 1 | 0 = prix de la livraison en 8 à 10 semaines 1 = prix de la livraison en 6 à 8 semaines (express) |
| gtr24_7 | 0 / 1 | 0 = GTR 4h en heures ouvrées et jours ouvrés 1 = GTR 4h en 24/7 |
| address ou siret | adresse numéro | adresse du site à raccorder (correction auto si proximité) numéro de SIRET du site à raccorder |
| coordinates | latitude, longitude | coordonnées GPS (latitude, longitude) séparées par une virgule |
Les données peuvent être envoyées :
• soit en GET dans l’URL
• soit via un POST JSON (voir exemples ci-dessous)
EXEMPLES :
Interrogation avec une adresse
GET : curl 'https://api.eurafibre.fr/coverage_areas/api/api_query?delivery_express=1>r24_7=1&address=20+rue+delbecque+deuvry&api_key=KEY' -H "Accept: application/json" -H "Content-Type: application/json" -X GET
JSON : curl "https://api.eurafibre.fr/coverage_areas/api/api_query?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json" -X GET -d '{"address":"20 rue delbecque deuvry"}'
Interrogation avec un numéro de siret
GET : curl 'https://api.eurafibre.fr/coverage_areas/api/api_query?delivery_express=1>r24_7=1&siret=53001863900019&api_key=API_KEY' -H "Accept: application/json" -H "Content-Type: application/json" -X GET
JSON : curl "https://api.eurafibre.fr/coverage_areas/api/api_query?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json" -X GET -d '{"siret":"53001863900019"}'
Interrogation avec une adresse non éligible (zone sur étude)
GET : curl 'https://api.eurafibre.fr/coverage_areas/api/api_query?delivery_express=1>r24_7=1&address= 20+rue+du+sac%2C+houdain&api_key=API_KEY' -H "Accept: application/json" -H "Content-Type: application/json" -X GET
JSON : curl "https://api.eurafibre.fr/coverage_areas/api/api_query?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json" -X GET -d '{"address":"20 rue du sac houdain"}'
Interrogation avec les coordonnées GPS
GET : curl 'https://api.eurafibre.fr/coverage_areas/api/api_query?delivery_express=1>r24_7=1&coordinates=50.639912,3.145560&api_key=API_KEY' -H "Accept: application/json" -H "Content-Type: application/json" -X GET
JSON : curl "https://api.eurafibre.fr/coverage_areas/api/api_query?api_key=API_KEY" -H "Accept: application/json" -H "Content-Type: application/json" -X GET -d '{"coordinates":"50.639912,3.145560"}'
PARAMÈTRES DE SORTIE (sous forme de tableau JSON) :
| Paramètre | Valeur | Description |
|---|---|---|
| address | ||
| number | numéro | |
| street | rue | |
| city | ville | |
| zip-code | code postal | |
| zonage | ZEURA/Z1/Z2/Z3/ZT1/ZN1/ZP1 | zone tarifaire Eurafibre |
| status | ok / ko | éligibilité |
| area | ||
| offers | ||
| bandwidth | 10 à 10000 | bande passante (en Mb/s) |
| fas | frais d’accès au service (en € HT) | |
| monthly_price | montant mensuel de la connexion (en € HT) | |
| commitment | 12/24/36/48/60 | durée minimale d’engagement (en mois) |
EXEMPLE :
https://api.eurafibre.fr/coverage_areas/api/api_query?delivery_express=1>r24_7=1&address=21%20av.%20de%20la%20creativit%C3%A9%20Villeneuve&api_key=API_KEY
(en remplaçant « API_KEY » par votre clé API)
Lorsque l’interrogation est correcte, un code de statut HTTP 200 est retourné avec :
• Soit Status : « ok »
• Soit Status : « ko » + un message indiquant que la zone n’est pas couverte
CODES D'ERREUR
| Code | Description |
|---|---|
| 418 | "Innacurate address. Submit a complete address" |
| 418 | "Wrong parameters. Submit a SIRET number or a complete address (example: siret=xxxxxxxxxxxxxx or address=1%20rue%20du%20Sac%2059000%20Houdain, or in json {\"address\":\"1 rue du sac houdain\"})." |
| 429 | "You have fired too many requests. Please wait #{watching_timespan} sec." |
| 500 | "Internal error" |
LIMITATIONS DE CHARGE :
Le nombre de requêtes par clé API est limité, par défaut, à
• 20 requêtes avec adresse par personne par minute
• 5 requêtes avec numéro de SIRET par personne par minute
En cas de dépassement, il faut attendre 5 minutes pour une remise à zéro des compteurs.
Si votre besoin est supérieur, nous vous invitons à contacter notre service commercial.