N-Ways
Documentation développeursZones

Zones

Zones

Sur cette page
Remarque :

Envoyez votre clé avec key=VOTRE_CLE_API dans l’adresse, ou dans l’en-tête X-NWays-Api-Key. Clés d’API

Adresse de base : https://nways.ng/maps/v1/fleet

Les zones du projet (des cercles), chacune avec le nombre de véhicules qui s’y trouvent

GET https://nways.ng/maps/v1/fleet/zones

cURL
curl "https://nways.ng/maps/v1/fleet/zones" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/zones', {
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()
Python
import os
import requests

res = requests.get(
    "https://nways.ng/maps/v1/fleet/zones",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Zones

ChampTypeDescription
zonesZone[]Obligatoire.
zones[].idstringObligatoire.
zones[].namestringObligatoire.
zones[].latnumberObligatoire.
zones[].lngnumberObligatoire.
zones[].radiusMintegerObligatoire.
zones[].vehiclesintegerObligatoire. Véhicules à l’intérieur en ce moment.
zones[].createdAtstring (date-time)Obligatoire.
zones[].updatedAtstring (date-time)Obligatoire.
200 OK
{
  "zones": [
    {
      "id": "string",
      "name": "string",
      "lat": 0,
      "lng": 0,
      "radiusM": 0,
      "vehicles": 0,
      "createdAt": "2026-10-15T09:00:00+01:00",
      "updatedAt": "2026-10-15T09:00:00+01:00"
    }
  ]
}

Erreurs

  • default Erreur

Ajouter une zone (200 au plus par projet)

POST https://nways.ng/maps/v1/fleet/zones

Les véhicules qui y entrent et en sortent envoient zone.entered et zone.exited, d’après la dernière position de chaque véhicule.

Corps de la requête

ChampTypeDescription
idstring
namestring100 caractères au plus.
latnumberObligatoire.
lngnumberObligatoire.
radiusMintegerObligatoire. ≥ 50, ≤ 50000.
cURL
curl -X POST "https://nways.ng/maps/v1/fleet/zones" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{"id":"depot-yaba","name":"Yaba depot","lat":6.5095,"lng":3.3711,"radiusM":300}'
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/zones', {
  method: 'POST',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "id": "depot-yaba",
    "name": "Yaba depot",
    "lat": 6.5095,
    "lng": 3.3711,
    "radiusM": 300
  }),
})
const data = await res.json()
Python
import os
import requests

res = requests.post(
    "https://nways.ng/maps/v1/fleet/zones",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    json={"id": "depot-yaba", "name": "Yaba depot", "lat": 6.5095, "lng": 3.3711, "radiusM": 300},
    timeout=10,
)
data = res.json()

Réponse

Créé

ChampTypeDescription
idstringObligatoire.
namestringObligatoire.
latnumberObligatoire.
lngnumberObligatoire.
radiusMintegerObligatoire.
vehiclesintegerObligatoire. Véhicules à l’intérieur en ce moment.
createdAtstring (date-time)Obligatoire.
updatedAtstring (date-time)Obligatoire.
201 OK
{
  "id": "string",
  "name": "string",
  "lat": 0,
  "lng": 0,
  "radiusM": 0,
  "vehicles": 0,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00"
}

Erreurs

  • default Erreur

Obtenir une zone

GET https://nways.ng/maps/v1/fleet/zones/{id}

Paramètres

NomOùTypeDescription
idcheminstringObligatoire.
cURL
curl "https://nways.ng/maps/v1/fleet/zones/string" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/zones/string', {
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()
Python
import os
import requests

res = requests.get(
    "https://nways.ng/maps/v1/fleet/zones/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Zone

ChampTypeDescription
idstringObligatoire.
namestringObligatoire.
latnumberObligatoire.
lngnumberObligatoire.
radiusMintegerObligatoire.
vehiclesintegerObligatoire. Véhicules à l’intérieur en ce moment.
createdAtstring (date-time)Obligatoire.
updatedAtstring (date-time)Obligatoire.
200 OK
{
  "id": "string",
  "name": "string",
  "lat": 0,
  "lng": 0,
  "radiusM": 0,
  "vehicles": 0,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00"
}

Erreurs

  • default Erreur

Renommer, déplacer ou redimensionner une zone (lat et lng ensemble)

PATCH https://nways.ng/maps/v1/fleet/zones/{id}

Paramètres

NomOùTypeDescription
idcheminstringObligatoire.

Corps de la requête

ChampTypeDescription
namestring100 caractères au plus.
latnumber
lngnumber
radiusMinteger≥ 50, ≤ 50000.
cURL
curl -X PATCH "https://nways.ng/maps/v1/fleet/zones/string" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","lat":0,"lng":0,"radiusM":0}'
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/zones/string', {
  method: 'PATCH',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "name": "string",
    "lat": 0,
    "lng": 0,
    "radiusM": 0
  }),
})
const data = await res.json()
Python
import os
import requests

res = requests.patch(
    "https://nways.ng/maps/v1/fleet/zones/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    json={"name": "string", "lat": 0, "lng": 0, "radiusM": 0},
    timeout=10,
)
data = res.json()

Réponse

Zone

ChampTypeDescription
idstringObligatoire.
namestringObligatoire.
latnumberObligatoire.
lngnumberObligatoire.
radiusMintegerObligatoire.
vehiclesintegerObligatoire. Véhicules à l’intérieur en ce moment.
createdAtstring (date-time)Obligatoire.
updatedAtstring (date-time)Obligatoire.
200 OK
{
  "id": "string",
  "name": "string",
  "lat": 0,
  "lng": 0,
  "radiusM": 0,
  "vehicles": 0,
  "createdAt": "2026-10-15T09:00:00+01:00",
  "updatedAt": "2026-10-15T09:00:00+01:00"
}

Erreurs

  • default Erreur

Supprimer une zone

DELETE https://nways.ng/maps/v1/fleet/zones/{id}

Paramètres

NomOùTypeDescription
idcheminstringObligatoire.
cURL
curl -X DELETE "https://nways.ng/maps/v1/fleet/zones/string" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/zones/string', {
  method: 'DELETE',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY },
})
const data = await res.json()
Python
import os
import requests

res = requests.delete(
    "https://nways.ng/maps/v1/fleet/zones/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Supprimé

Pas de contenu.

Erreurs

  • default Erreur