Retour aux guides

Éligibilité de masse

L'éligibilité de masse permet de soumettre un lot d'adresses pour obtenir les résultats de couverture FTTx en batch. Idéal pour les migrations de parc, les analyses de couverture ou les imports massifs.

Limites : Maximum 10 000 adresses par batch. Pour des volumes supérieurs, découpez en plusieurs requêtes.
1

Soumettre le batch

Envoyez la liste d'adresses avec un webhook optionnel pour être notifié à la fin du traitement.

POST/v1/eligibility/batch

Crée un nouveau batch d'éligibilité. Retourne un identifiant de batch pour le suivi.

Paramètres

NomTypeRequisDescription
addressesarray
requis
Liste d'adresses (max 10 000)
addresses[].externalIdstring
optionnel
Votre identifiant interne pour chaque adresse
addresses[].streetstring
requis
Numero et nom de rue
addresses[].citystring
requis
Nom de la commune
addresses[].postalCodestring
requis
Code postal
webhookUrlstring
optionnel
URL de callback notifiée à la fin du traitement
bash
curl -X POST https://api.netwo.io/v1/eligibility/batch \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "addresses": [
      {
        "externalId": "site-001",
        "street": "15 rue de la Paix",
        "city": "Paris",
        "postalCode": "75002"
      },
      {
        "externalId": "site-002",
        "street": "1 place Bellecour",
        "city": "Lyon",
        "postalCode": "69002"
      }
    ],
    "webhookUrl": "https://your-system.com/webhooks/eligibility"
  }'
2

Suivre la progression

Deux options : polling du statut ou notification par webhook.

Option A : Polling

GET/v1/eligibility/batch/{batchId}

Retourne le statut et la progression du batch.

json
{
  "batchId": "bat_xyz789",
  "status": "PROCESSING",
  "totalAddresses": 150,
  "processedAddresses": 42,
  "progress": 28,
  "createdAt": "2024-01-15T10:30:00Z",
  "estimatedCompletion": "2024-01-15T10:35:00Z"
}
bash
# Verifier le statut du batch
curl https://api.netwo.io/v1/eligibility/batch/bat_xyz789 \
  -H "Authorization: Bearer YOUR_API_KEY"

# Recuperer les resultats (une fois le batch termine)
curl https://api.netwo.io/v1/eligibility/batch/bat_xyz789/results \
  -H "Authorization: Bearer YOUR_API_KEY"

Option B : Webhook

Si vous avez fourni un webhookUrl, un POST est envoyé à cette URL une fois le batch terminé.

json
{
  "event": "batch.completed",
  "batchId": "bat_xyz789",
  "status": "COMPLETED",
  "totalAddresses": 150,
  "processedAddresses": 150,
  "resultsUrl": "https://api.netwo.io/v1/eligibility/batch/bat_xyz789/results"
}
3

Récupérer les résultats

Une fois le batch terminé, récupérez les résultats complets.

GET/v1/eligibility/batch/{batchId}/results

Retourne les résultats d'éligibilité pour chaque adresse du batch. Supporte la pagination.

Paramètres

NomTypeRequisDescription
pagenumber
optionnel
Numéro de page (défaut: 1)
perPagenumber
optionnel
Résultats par page (défaut: 100, max: 1000)