Commander une ligne

Pour créer une commande d'activation, il faut obtenir dans un premier temps un résultat d'éligibilité. Cette page décrit l'ordre des appels API vous permettant de récupérer ce résultat, en fonction de la famille de produit.

Le référentiel d'adresses commun fibre et cuivre de Covage permet de faire des éligibilités croisées. Pour cela, vous pouvez récupérer l'adresse d'un NDI ou d'un bâtiment pour pouvoir ensuite changer de type d'éligibilité (cuivre ou fibre).

Avertissement

La description de l'ancienne méthode est disponible ici. Elle ne doit pas être utilisée pour de nouveaux développements.

Commander une ligne cuivre depuis une adresse

Action	URL	Paramètres appel API (* à récupérer du ou des précédent(s) appel(s))
Lister les communes	/api/v2/eligibility/cities/	zipcode
Lister les rues	/api/v2/eligibility/streets/	*kosc_insee_code
Lister les numéros de rue	/api/v2/eligibility/street_numbers/	*kosc_street_code
Lister les endpoints d'une adresse	/api/v2/eligibility/endpoints/	*kosc_street_code [and *street_number]
Obtenir une éligibilité cuivre	/api/v2/eligibility/offers/	*reference (endpoint_ref), *reference_type (endpoint_ref_type), *status and activation_type
Commander la ligne cuivre	/api/v2/orders/	*eligibility_ref and *product.code

Commander une ligne cuivre depuis une référence de ligne

Action	URL	Paramètres appel API (* à récupérer du ou des précédent(s) appel(s))
Obtenir une éligibilité cuivre	/api/v2/eligibility/offers/	reference, reference_type, status and activation_type
Commander la ligne cuivre	/api/v2/orders/	*eligibility_ref and *product.code

Commander une ligne fibre depuis un code immeuble

Action	URL	Paramètres appel API (* à récupérer du ou des précédent(s) appel(s))
Lister les communes	/api/v2/eligibility/cities/	zipcode
Lister les rues	/api/v2/eligibility/streets/	*kosc_insee_code
Lister les numéros de rue	/api/v2/eligibility/street_numbers/	*kosc_street_code
Lister les buildings	/api/v2/eligibility/buildings/	*kosc_street_code [and *street_number]
Obtenir une éligibilité fibre	/api/v2/eligibility/offers/	*reference (building_ref) and reference_type
Commander la ligne fibre	/api/v2/orders/	*eligibility_ref and *product.code

Commander une ligne fibre depuis une prise optique

Action	URL	Paramètres appel API (* à récupérer du ou des précédent(s) appel(s))
Obtenir une éligibilité fibre	/api/v2/eligibility/offers/	reference and reference_type
Commander la ligne fibre	/api/v2/orders/	*eligibility_ref* and *product.code

Commander une ligne fibre depuis une ligne cuivre

Action	URL	Paramètres appel API (* à récupérer du ou des précédent(s) appel(s))
Récupérer l'adresse de l'endpoint cuivre	/api/v2/eligibility/endpoints/	endpoint_ref
Lister les buildings	/api/v2/eligibility/buildings/	*kosc_street_code [and *street_number]
Obtenir une éligibilité fibre	/api/v2/eligibility/offers/	*reference (building_ref) and reference_type
Commander la ligne fibre	/api/v2/orders/	*eligibility_ref* and *product.code