Retour aux guides

Création de service

Commandez et activez une nouvelle ligne FTTH auprès d'un OI via l'API unifiée Netwo. Ce guide couvre la création d'un service et le suivi de son statut jusqu'à l'activation.

Info : Netwo traduit automatiquement votre requête vers le protocole de l'OI concerné (interopFibre ou propriétaire). L'OC reste titulaire du contrat avec l'OI, Netwo agit comme passerelle technique pour simplifier l'intégration.
Prérequis : clé API valide et au moins une éligibilité positive sur l'adresse concernée.

Créer un service

Créez un nouveau service FTTH activé en fournissant les informations de l'offre éligible, le produit souhaité et les coordonnées du contact sur site.

POST/v1/services

Crée une nouvelle commande de service FTTH activé auprès de l'opérateur d'infrastructure.

Paramètres

NomTypeRequisDescription
operatorCodestring
requis
Code de l'opérateur d'infrastructure (ex: AXIONE, ORANGE, COVAGE)
buildingRefstring
requis
Référence immeuble IPE (format IMB/xxxxx/x/xxxx)
offerCodestring
requis
Code de l'offre issue de la réponse d'éligibilité
productstring
requis
Type de produit commandé (ex: FTTH_ACTIVATED)
customerRefstring
optionnel
Référence interne OC pour ce service
contactNamestring
requis
Nom du contact sur site
contactPhonestring
requis
Téléphone du contact (format international)
contactEmailstring
requis
Email du contact sur site
desiredActivationDatestring
optionnel
Date souhaitée d'activation (format ISO 8601)
bash
curl -X POST https://api.netwo.io/v1/services \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "operatorCode": "AXIONE",
    "buildingRef": "IMB/33063/C/025A",
    "offerCode": "FTTH_ACT_1G",
    "product": "FTTH_ACTIVATED",
    "customerRef": "CLI-COV-98765",
    "contactName": "Jean Dupont",
    "contactPhone": "+33612345678",
    "contactEmail": "jean.dupont@example.com",
    "desiredActivationDate": "2024-04-15T08:00:00Z"
  }'

Consulter un service

Récupérez les détails et le statut actuel d'un service existant à partir de son identifiant.

GET/v1/services/{serviceId}

Retourne les détails complets d'un service, y compris son statut et les dates prévisionnelles d'activation.

bash
curl https://api.netwo.io/v1/services/SRV-2024-00187 \
  -H "Authorization: Bearer YOUR_API_KEY"

Format de réponse

Les deux endpoints retournent le même format de réponse avec les détails du service, l'opérateur, l'offre souscrite, le produit et les informations de contact.

json
{
  "id": "SRV-2024-00187",
  "status": "PENDING",
  "operator": {
    "code": "AXIONE",
    "name": "Axione",
    "protocol": "INTEROP_FIBRE"
  },
  "offer": {
    "code": "FTTH_ACT_1G",
    "technology": "FTTH",
    "maxDownload": 1000,
    "maxUpload": 500
  },
  "buildingRef": "IMB/33063/C/025A",
  "product": "FTTH_ACTIVATED",
  "customerRef": "CLI-COV-98765",
  "contact": {
    "name": "Jean Dupont",
    "phone": "+33612345678",
    "email": "jean.dupont@example.com"
  },
  "dates": {
    "createdAt": "2024-03-15T10:30:00Z",
    "desiredActivationDate": "2024-04-15T08:00:00Z",
    "estimatedActivation": "2024-04-12T00:00:00Z"
  },
  "createdAt": "2024-03-15T10:30:00Z"
}