Retour aux guides

Modification de service

L'API unifiée Netwo permet de modifier le débit d'un service FTTH actif (upgrade ou downgrade) sans avoir à gérer les spécificités de chaque opérateur d'infrastructure. Le processus se déroule en trois étapes : lister les offres disponibles, demander la modification, puis suivre son avancement.

Info : La modification de débit est sans interruption de service. Le changement est effectif à la date demandée ou au prochain cycle de facturation selon l'OI.

Lister les offres disponibles

Récupérez la liste des offres vers lesquelles le service peut être modifié (upgrade ou downgrade), avec les tarifs associés.

GET/v1/services/{serviceId}/offers

Retourne l'offre actuelle du service ainsi que les offres cibles disponibles pour une modification de débit.

bash
curl https://api.netwo.io/v1/services/SVC-2024-00312/offers \
  -H "Authorization: Bearer YOUR_API_KEY"

Demander une modification

Soumettez une demande de modification de débit en précisant l'offre cible, la date souhaitée et le motif.

PATCH/v1/services/{serviceId}

Demande une modification de débit sur un service FTTH actif.

Paramètres

NomTypeRequisDescription
targetOfferCodestring
requis
Code de l'offre cible issue de la liste des offres disponibles
effectiveDatestring
optionnel
Date souhaitée pour la prise d'effet (format ISO 8601). Si absente, appliquée au prochain cycle de facturation
reasonstring
optionnel
Motif de la modification (à titre informatif)
bash
curl -X PATCH https://api.netwo.io/v1/services/SVC-2024-00312 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "targetOfferCode": "FTTH_ACT_2G",
    "effectiveDate": "2024-05-01T00:00:00Z",
    "reason": "Upgrade débit client vers 2 Gbps"
  }'

Suivre une modification

Consultez le statut et les détails d'une modification en cours ou passée à partir de son identifiant.

GET/v1/services/{serviceId}/modifications/{modificationId}

Retourne les détails complets d'une modification, y compris son statut, les offres source et cible, et la date effective.

bash
curl https://api.netwo.io/v1/services/SVC-2024-00312/modifications/MOD-2024-00087 \
  -H "Authorization: Bearer YOUR_API_KEY"

Réponse - Offres disponibles

La liste des offres retourne l'offre actuelle du service et les offres cibles possibles avec leur type (UPGRADE ou DOWNGRADE) et le tarif mensuel.

json
{
  "serviceId": "SVC-2024-00312",
  "currentOffer": {
    "code": "FTTH_ACT_1G",
    "technology": "FTTH",
    "maxDownload": 1000,
    "maxUpload": 500,
    "monthlyPrice": 29.90
  },
  "availableOffers": [
    {
      "code": "FTTH_ACT_500M",
      "technology": "FTTH",
      "maxDownload": 500,
      "maxUpload": 250,
      "monthlyPrice": 19.90,
      "type": "DOWNGRADE"
    },
    {
      "code": "FTTH_ACT_2G",
      "technology": "FTTH",
      "maxDownload": 2000,
      "maxUpload": 1000,
      "monthlyPrice": 39.90,
      "type": "UPGRADE"
    },
    {
      "code": "FTTH_ACT_8G",
      "technology": "FTTH",
      "maxDownload": 8000,
      "maxUpload": 4000,
      "monthlyPrice": 59.90,
      "type": "UPGRADE"
    }
  ]
}

Réponse - Suivi de modification

Le suivi de modification retourne le statut actuel, les offres précédente et cible, ainsi que la date effective prévue.

json
{
  "modificationId": "MOD-2024-00087",
  "serviceId": "SVC-2024-00312",
  "status": "PENDING",
  "previousOffer": {
    "code": "FTTH_ACT_1G",
    "maxDownload": 1000,
    "maxUpload": 500
  },
  "targetOffer": {
    "code": "FTTH_ACT_2G",
    "maxDownload": 2000,
    "maxUpload": 1000
  },
  "reason": "Upgrade débit client vers 2 Gbps",
  "effectiveDate": "2024-05-01T00:00:00Z",
  "createdAt": "2024-04-15T14:22:00Z"
}
Guide précédent : Création de serviceGuide suivant : Résiliation de service