Eligibilité
Netwo - API Eligibilité
Cinématique des échanges
Sélection de l'immeuble
Get Closest Imb to Some Coordinates
Cette étape permet d'obtenir l'identifiant de l'immeuble le plus proche des coordonnées géographiques passées en paramètre.
La sélection de l'immeuble est particulièrement utile pour tester l'éligibilité aux offres FTTH.
Ce résultat est basé sur le référentiel IMB
Requête
La route GET /imb/closest
prend en paramètres les coordonnées géographiques (système de coordonnées WGS84):
- lat : latitude
- lng : longitude
Exemple
GET /imb/closest?lat=48.869675&lng=2.3438333
Réponse
la réponse liste les caractéristiques de l'immeuble le plus proche :
lat
: La latitude de l'immeublelng
: La longitude de l'immeubleimb_id
: L'identifiant de l'immeuble (cet identifiant doit être passé en paramètre du test d'éligibilité)imb_status
: Le statut de déploiement de la FTTH dans l'immeuble (à titre indicatif)pm_id
: L'identifiant du point de mutualisation auquel est raccordé l'immeuble (cet identifiant doit être passé en paramètre du test d'éligibilité)pm_status
: Le statut de déploiement du point de mutualisation (à titre indicatif)street_number
,street
,city
,post_code
: L'adresse de l'immeuble
Exemple de réponse :
{
"lat": 48.8696244088267,
"lng": 2.34379400749012,
"imb_id": "IMB/75102/C/1900",
"imb_status": "Deployed",
"pm_id": "FI-75102-00L8",
"pm_status": "Deployed",
"street_number": 35,
"street": "rue des jeuneurs",
"city": "PARIS 02",
"post_code": 75002
}
Il est également possible de lister les immeubles environnants afin de permettre à l'utilisateur de sélectionner un immeuble voisin grâce à la route
GET /imb/list??lat=48.869675&lng=2.3438333&half_side=200
.le rayon de recherche en mètre doit être précisé grâce au paramètre
half_side
.
Préselection de l'adresse
Eligibility Preselection of the Customer
Cette étape permet à l'utilisateur d'apporter une précision sur la localisation au sein du bâtiment à raccorder en lui présentant, quand c'est possible, une liste indiquant le nom du client ou d'un prédécesseur, le numéro de l'étage et / ou un élément d'identification télécom (numéro de téléphone, identifiant de point de terminaison optique, ...).
Cette sélection est particuloèrement utile pour un test d'éligibilité aux offres cuivre.
Ce résultat est basé sur le référentiel SETIAR (boucle local cuivre)
Requête
La route POST /eligibility/preselect
prend l'un des 3 paramètres suivants :
- Une adresse textuelle sous la forme
{"address": "35 Rue des Jeuneurs, 75002 Paris"}
- Des coordonnées géographique (WGS84) sous la forme
{"latitude":"48.869675","longitude":"2.3438333"}
- Un numéro de téléphone identifiant la tête de ligne sous la forme
{"number": "01 40 16 43 55"}
Exemple de requête avec une adresse textuelle:
POST /eligibility/preselect
{
"address": "35 Rue des Jeuneurs, 75002 Paris"
}
Réponse
La réponse est composée d'un objet default
et d'un objet matches
L'objet matches
contient éventuellement une liste d'objets value
contenant :
- Les coordonnées géographiques éventuellement corrigées (
original_coordinates
) - L'adresse textuelle structurée (
address
) - les informations détaillées au sein du bâtiment (
details
).
L'objet default
, contient systématiquement un objet value
qui restitue uniquement l'adresse ainsi que les coordonnées.
L'objet
default
ne sera pas présent en cas de recherche pas numéro, l'identification de la ligne cuivre étant indispensable pour la suite du processus d'éligibilité.
Il s'agit d'un choix par défaut permettant à l'utilisateur d'indiquer qu'aucune des réponses présentes dans le liste matches
ne correspond précisément au lieu de raccordement souhaité.
NB : l'un des objets value
devra être passé en paramètre à l'étape suivante (Test d'éligibilié)
Exemple de réponse :
{
"default": {
"value": {
"country": "FR",
"coordinates": {
"latitude": "48.869658",
"longitude": "2.343825"
},
"original_coordinates": {
"latitude": "48.869675",
"longitude": "2.3438333"
},
"address": {
"country": "FR",
"postal_code": "75002",
"city": "Paris",
"street": "Rue des Jeuneurs",
"street_number": "35",
"insee_municipality_code": "75102"
},
"details": {}
},
"signature": "ZyYRF6pq3H3lUVOZiMyTfYLKqcZFYQlb8h4UFu3iS4E="
},
"matches": [
{
"value": {
"country": "FR",
"coordinates": {
"latitude": "48.8696514",
"longitude": "2.3434261"
},
"original_coordinates": {
"latitude": "48.869675",
"longitude": "2.3438333"
},
"phoneNumber": "0140204966",
"address": {
"country": "France",
"postal_code": "75002",
"city": "Paris",
"street": "RUE DES JEUNEURS",
"street_number": "39",
"insee_municipality_code": "75102"
},
"details": {
"owner": "Name 1",
"floor": "00"
}
},
"signature": "HwrRjK28ygeMyuah/qJJt/S0qXSxe12/VO3yPBgG0X8="
},
{
"value": {
"country": "FR",
"coordinates": {
"latitude": "48.8696514",
"longitude": "2.3434261"
},
"original_coordinates": {
"latitude": "48.869675",
"longitude": "2.3438333"
},
"phoneNumber": "0140262513",
"address": {
"country": "France",
"postal_code": "75002",
"city": "Paris",
"street": "RUE DES JEUNEURS",
"street_number": "39",
"insee_municipality_code": "75102"
},
"details": {
"owner": "NAME 2"
}
},
"signature": "tDLJFTf2gGTBeR34bnHiOpcpnW3KjHWPI8aunu02Xm0="
}
]
}
Test d'éligibilié
Eligibility Request Handler
Cette étape permet d'exécuter un test d'éligibilité auprès de tous les opérateurs disponibles sur la plate-forme Netwo, pour un marché ciblé.
Requête
La route POST /eligibility
prend 4 paramètres :
market
: le marché cible (seul la valeurservice_operator
est supportée actuellement)offer_type
: Segment client [enterprise
|professional
] (pré-filtre les résultats en fonction du segment client)value
: l'un des résultats obtenus à l'étape de préselection d'une adresse (décrit plus haut au paragraphe Préselection de l'adresse)signature
: Signature associée au résultatvalue
obtenue lors de l'étape de péselectionftth_payload
: Informations de l'immeuble (FTTH) obtenues à l'étape de sélection de l'immeubleimb_ref
: Identifiant de l'immeublepm_ref
: Identifiant du point de mutualisation auquel est raccordé l'immeuble.
Exemple d'une requête :
POST /eligibility
{
"market":"service_operator",
"offer_type":"enterprise",
"signature":"ZyYRF6pq3H3lUVOZiMyTfYLKqcZFYQlb8h4UFu3iS4E",
"ftth_payload": {
"imb_ref": "IMB/75102/C/1900",
"pm_ref": "FI-75102-00L8"
},
"value":{
"country":"FR",
"coordinates":{
"latitude":"48.869658",
"longitude":"2.343825"
},
"original_coordinates":{
"latitude":"48.869675",
"longitude":"2.3438333"
},
"address":{
"country":"FR",
"postal_code":"75002",
"city":"Paris",
"street":"Rue des Jeuneurs",
"street_number":"35",
"insee_municipality_code":"75102"
},
"details":{
}
}
}
Réponse
L'exécution du test d'éligibilité et la collecte de tous les résultats peuvent prendre plusieurs secondes c'est pourquoi cette opération est asynchrone.
La réponse comprend uniquement un identifiant (ìd
) correspondant au test d'éligibilité exécuté. Cet identifiant sera utile notamment lors de l'étape de restitution des résultats.
Exemple d'une réponse:
{
"id": "ef8b46e9-dbcb-425e-9f4f-125b69d2226b"
}
Verification de la progression de la collecte des résultats
Eligibility Status
Avant de tenter de restituer les résultats, il peut être utile de consulter la progression de la collecte des réponses.
La route GET eligibility/{{eligibilityId}}/status
permet de connaître, par opérateur, si des réponses sont en attentes, reçues ou si une erreur a été identifiée provenant d'un ou plusieurs opérateurs.
Requête
La route GET eligibility/{{eligibilityId}}/status
prend en paramètres eligibilityId
obtenu lors de l'étape précédente.
Réponse
La réponse contient 3 tableaux :
pending
: liste des opérateurs desquels une réponse est attenduesuccesses
: liste des opérateurs desquels une réponse a été reçue associés aux nombres de résultats que contient la réponse.errors
: liste des opérateurs ayant renvoyé une erreur
Exemple d'une réponse:
{
"pending": [
"appliwave",
"celeste",
"eurafibre",
"ielo",
"orange",
"prizz"
],
"successes": [
{
"resolver": "axione",
"result_count": 2
},
{
"resolver": "colt",
"result_count": 6
}
],
"errors": null
}
Restitution des résultats
Eligibility Response Handler
Cette étape permet la restitution des offres disponibles des différents opérateurs en fonction de l'adresse saisie.
La liste obtenue est triable ou filtrable selon les attributs suivants:
Filtres
Les résultats peuvent être filtrés selon les critères :
access_fee
: permet de filtrer sur le montant des frais d'accès au servicerecurring_price
: permet de filtrer sur le montant des frais récurrentsdebit
: permet de filtrer sur la valeur des débits descendantsinfrastructure_type
: permet de filtrer sur un ou plusieurs types de technologie d'infrastructure- ftto
- ftth
- ftte
- vdsl
- sdsl
- adsl
- mobile
Tris
Les résultats peuvent être triés en ajoutant le paramètre sort_by
selon les caractéristiques suivantes :
debit
: valeur des débits descendantsrecurring_price
: montant des frais récurrentsservice_guarantee
: niveau de garantieaccess_fee
: montant des frais d'accès au servicecommitment_duration
: valeur des durées d'engagement
Requête
La route GET /eligibility
prend en paramètre eligibility_id
obtenu lors de l'étape du test d'éligibilité ainsi qu'un ou plusieurs paramètres de filtre et un paramètre de tri.
Exemple d'une requête:
GET /eligibility/db23cee9-eef5-45e4-bb95-5c1fa037114a?recurring_price=1296.lte&access_fee=3240.lte&debit=10.gte&sort_by=service_guarantee.asc&include_all_results=true&offer_type=enterprise
Réponse
La réponse est une liste results
de produits disponibles à l'adresse saisie.
filtered_out_results
contient la liste des résultats filtrés.
Chaque offre contient une liste de variantes. Les variantes sont les combinatoires des valeurs de différentes caractéristiques qui impactent généralement le prix.
Voici un exemple de liste de variantes pour une liaison fibre :
Débit | Engagement | Prix réccurent |
---|---|---|
100 Mb/s | 12 mois | 290 € |
200 Mb/s | 12 mois | 331 € |
100 Mb/s | 24 mois | 238 € |
200 Mb/s | 24 mois | 310 € |
Attributs des offres :
eligibility_id
: identifiant d'éligibilité passé en paramètreresolver
: identifiant du processus de résolutionproduct_id
: identifiant de l'offrecontract_version_id
: identifiant de la version du contrat auquel l'offre appartientproduct_name
: Nom commercial de l'offreservice_operator
: Nom de l'opérateur vendeurinfrastructure_operator
: Nom de l'opérateur de d'infrastructureinfrastructure_type
: Nom du types de technologie d'infrastructure
Attributs des variantes :
entity_id
: identifiant de la variantename
: Nom de la variantedebit
: débit de la liaisonaccess_fee
: frais d'accès au servicerecurring_price
: Frais réccurentscommitment_duration
: durée d'engagementintervention_time_guaranteed_delay
: garantie de temps d'interventionintervention_time_guaranteed_applicability
: application de la garantie de temps d'interventionrecovery_time_guaranteed_delay
: garantie de temps de rétablissementrecovery_time_guaranteed_applicability
: application de la garantie de temps de rétablissementpreferred_offer
: variante mise en avant
Exemple d'une réponse :
{
"results": [
{
"eligibility_id": "af9f0218-6df2-4339-bde2-175cb7a0ca42",
"resolver": "prizz",
"product_id": "34eb44a6-e201-47e2-82e3-4923897e733f",
"contract_version_id": "03ed55e2-4ebb-4f3e-bacd-797a5587cb9a",
"product_name": "FTTO Paris",
"service_operator": "Netwo",
"infrastructure_operator": "Prizz infrastructure",
"infrastructure_type": "ftto",
"entities": [
{
"entity_id": "42b9835d-5fda-4d21-ae93-b843ea19f554",
"name": "NEARNET Paris Zone1 100 Mbit/s 12 months",
"debit": 100.0,
"access_fee": 518.96,
"recurring_price": 290.16,
"commitment_duration": 12,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "5bf199ae-7d13-4f89-9f41-e55745afc753",
"name": "Leonix Infra NEARNET Paris Zone1 200 Mbit/s 24 months",
"debit": 200.0,
"access_fee": 518.96,
"recurring_price": 279.76,
"commitment_duration": 24,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "e89f49cc-c69b-43d8-93da-d7dae9d98f01",
"name": "Leonix Infra NEARNET Paris Zone1 300 Mbit/s 12 months",
"debit": 300.0,
"access_fee": 0.0,
"recurring_price": 383.76,
"commitment_duration": 12,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "a4973913-18e2-4bdd-b383-e0a977d17273",
"name": "Leonix Infra NEARNET Paris Zone1 100 Mbit/s 36 months",
"debit": 100.0,
"access_fee": 518.96,
"recurring_price": 206.96,
"commitment_duration": 36,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "0ad4447f-95c4-4470-9aee-a1e432d53606",
"name": "Leonix Infra NEARNET Paris Zone1 10 Mbit/s 36 months",
"debit": 10.0,
"access_fee": 518.96,
"recurring_price": 123.76,
"commitment_duration": 36,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "28de1dc2-1c89-4eda-b69d-96d9f1a852ba",
"name": "Leonix Infra NEARNET Paris Zone1 10 Mbit/s 24 months",
"debit": 10.0,
"access_fee": 518.96,
"recurring_price": 144.56,
"commitment_duration": 24,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "ed415131-52c5-4ea1-9b99-f600890027cd",
"name": "Leonix Infra NEARNET Paris Zone1 500 Mbit/s 12 months",
"debit": 500.0,
"access_fee": 0.0,
"recurring_price": 435.76,
"commitment_duration": 12,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "09785de2-3441-48ea-b975-f2c7194acafd",
"name": "Leonix Infra NEARNET Paris Zone1 300 Mbit/s 24 months",
"debit": 200.0,
"access_fee": 0.0,
"recurring_price": 310.96,
"commitment_duration": 24,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "ced060e2-5b67-4df3-b4a5-6fb2a572bfb7",
"name": "Leonix Infra NEARNET Paris Zone1 20 Mbit/s 24 months",
"debit": 20.0,
"access_fee": 518.96,
"recurring_price": 186.16,
"commitment_duration": 24,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "62503a34-f35f-49d9-a813-57eda3c0ae9e",
"name": "Leonix Infra NEARNET Paris Zone1 10 Mbit/s 12 months",
"debit": 10.0,
"access_fee": 518.96,
"recurring_price": 175.76,
"commitment_duration": 12,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "823efdca-828a-4433-9dde-51e1d9f6f2d4",
"name": "Leonix Infra NEARNET Paris Zone1 200 Mbit/s 36 months",
"debit": 200.0,
"access_fee": 518.96,
"recurring_price": 238.16,
"commitment_duration": 36,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "9c49c537-e2af-4443-a55b-b2e9afefbe79",
"name": "Leonix Infra NEARNET Paris Zone1 300 Mbit/s 36 months",
"debit": 300.0,
"access_fee": 0.0,
"recurring_price": 269.36,
"commitment_duration": 36,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "b8d58643-51a2-4ef6-896f-a1826842335f",
"name": "Leonix Infra NEARNET Paris Zone1 500 Mbit/s 24 months",
"debit": 500.0,
"access_fee": 0.0,
"recurring_price": 362.96,
"commitment_duration": 24,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "44ea7d79-b564-4092-ae2c-2debc0dd8ab5",
"name": "Leonix Infra NEARNET Paris Zone1 1 Gbit/s 12 months",
"debit": 1000.0,
"access_fee": 0.0,
"recurring_price": 508.56,
"commitment_duration": 12,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "ce0885e7-f295-43f4-a110-3c3174d932e6",
"name": "Leonix Infra NEARNET Paris Zone1 1 Gbit/s 36 months",
"debit": 1000.0,
"access_fee": 0.0,
"recurring_price": 362.96,
"commitment_duration": 36,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "b0911547-2820-4f62-b6fe-067069fae53e",
"name": "Leonix Infra NEARNET Paris Zone1 500 Mbit/s 36 months",
"debit": 500.0,
"access_fee": 0.0,
"recurring_price": 310.96,
"commitment_duration": 36,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "475db077-1c98-40c3-b450-ce4e47ea2907",
"name": "Leonix Infra NEARNET Paris Zone1 20 Mbit/s 12 months",
"debit": 20.0,
"access_fee": 518.96,
"recurring_price": 217.36,
"commitment_duration": 12,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "9afb7a19-f2f7-477a-9c5d-d920ba5c4d72",
"name": "Leonix Infra NEARNET Paris Zone1 20 Mbit/s 36 months",
"debit": 20.0,
"access_fee": 518.96,
"recurring_price": 154.96,
"commitment_duration": 36,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "db23cee9-eef5-45e4-bb95-5c1fa037114a",
"name": "Leonix Infra NEARNET Paris Zone1 200 Mbit/s 12 months",
"debit": 200.0,
"access_fee": 518.96,
"recurring_price": 331.76,
"commitment_duration": 12,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "2cf889ec-c054-4d8e-835c-a6ce371c2262",
"name": "NEARNET Paris Zone1 100 Mbit/s 24 months",
"debit": 100.0,
"access_fee": 518.96,
"recurring_price": 238.16,
"commitment_duration": 24,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
},
{
"entity_id": "b20a0d94-3c9e-40de-adcc-28db55842f15",
"name": "Leonix Infra NEARNET Paris Zone1 1 Gbit/s 24 months",
"debit": 1000.0,
"access_fee": 0.0,
"recurring_price": 425.36,
"commitment_duration": 24,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "PT4H",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": false
}
]
},
{
"eligibility_id": "af9f0218-6df2-4339-bde2-175cb7a0ca42",
"resolver": "prizz",
"product_id": "de199d69-46ca-48b4-ac9c-dd2f4e71fe6b",
"contract_version_id": "03ed55e2-4ebb-4f3e-bacd-797a5587cb9a",
"product_name": "FTTO débit burst",
"service_operator": "Netwo",
"infrastructure_operator": "Prizz infrastructure",
"infrastructure_type": "ftto",
"entities": [
{
"entity_id": "d57c661a-7ff2-4bf2-b4d7-91d64001ddf9",
"name": "NEARNET Zone1 1Gbit/s",
"debit": 1000.0,
"access_fee": 830.96,
"recurring_price": 154.96,
"commitment_duration": 24,
"intervention_time_guaranteed_delay": null,
"intervention_time_guaranteed_applicability": null,
"recovery_time_guaranteed_delay": "P1D",
"recovery_time_guaranteed_applicability": "working_days",
"preferred_offer": true
}
]
}
],
"filtered_out_results": []
}
Updated over 1 year ago