Rider links

Sur cette page

Les liens livreur du véhicule (jamais leurs adresses), du plus récent au plus ancien
Un lien que le livreur ouvre sur son téléphone pour partager sa position pour ce véhicule (sans application)
Arrêter aussitôt un lien livreur (sa page dit alors qu’il a pris fin)

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 liens livreur du véhicule (jamais leurs adresses), du plus récent au plus ancien

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

Paramètres

Nom	Où	Type	Description
`id`	chemin	`string`	Obligatoire.

cURL

curl "https://nways.ng/maps/v1/fleet/vehicles/string/links" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/vehicles/string/links', {
  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/vehicles/string/links",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Liens

Champ	Type	Description
`links`	`RiderLink[]`	Obligatoire.
`links[].id`	`string`	Obligatoire.
`links[].vehicleId`	`string`	Obligatoire.
`links[].url`	`string (uri)`	Seulement à la création : https://nways.ng/d/<jeton>.
`links[].createdBy`	`string`	Obligatoire.
`links[].createdAt`	`string (date-time)`	Obligatoire.
`links[].expiresAt`	`string (date-time)`	Obligatoire.
`links[].revokedAt`	`string (date-time) \| null`	Obligatoire.
`links[].consentedAt`	`string (date-time) \| null`	Obligatoire. Quand le livreur a accepté de partager.
`links[].lastUsedAt`	`string (date-time) \| null`	Obligatoire.
`links[].active`	`boolean`	Obligatoire.

200 OK

{
  "links": [
    {
      "id": "lnk_c8RdT5wQ1e",
      "vehicleId": "string",
      "url": "string",
      "createdBy": "string",
      "createdAt": "2026-10-15T09:00:00+01:00",
      "expiresAt": "2026-10-15T09:00:00+01:00",
      "revokedAt": "2026-10-15T09:00:00+01:00",
      "consentedAt": "2026-10-15T09:00:00+01:00",
      "lastUsedAt": "2026-10-15T09:00:00+01:00",
      "active": true
    }
  ]
}

Erreurs

default Erreur

Un lien que le livreur ouvre sur son téléphone pour partager sa position pour ce véhicule (sans application)

POST https://nways.ng/maps/v1/fleet/vehicles/{id}/links

L’url de la réponse (https://nways.ng/d/…) n’est montrée qu’une fois : envoyez-la au livreur. La page lui demande son accord, puis partage la position du téléphone tant qu’elle est ouverte et le partage activé, montre ses livraisons ouvertes et lui permet d’en marquer une récupérée ou livrée. Les positions comptent comme POST /locations pour ce véhicule.

Paramètres

Nom	Où	Type	Description
`id`	chemin	`string`	Obligatoire.

Corps de la requête

Champ	Type	Description
`days`	`integer`	Durée de validité du lien. Par défaut: `30`. ≥ 1, ≤ 90.

cURL

curl -X POST "https://nways.ng/maps/v1/fleet/vehicles/string/links" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{"days":30}'

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/vehicles/string/links', {
  method: 'POST',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "days": 30
  }),
})
const data = await res.json()

Python

import os
import requests

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

Réponse

Le lien avec son url

Champ	Type	Description
`id`	`string`	Obligatoire.
`vehicleId`	`string`	Obligatoire.
`url`	`string (uri)`	Seulement à la création : https://nways.ng/d/<jeton>.
`createdBy`	`string`	Obligatoire.
`createdAt`	`string (date-time)`	Obligatoire.
`expiresAt`	`string (date-time)`	Obligatoire.
`revokedAt`	`string (date-time) \| null`	Obligatoire.
`consentedAt`	`string (date-time) \| null`	Obligatoire. Quand le livreur a accepté de partager.
`lastUsedAt`	`string (date-time) \| null`	Obligatoire.
`active`	`boolean`	Obligatoire.

201 OK

{
  "id": "lnk_c8RdT5wQ1e",
  "vehicleId": "string",
  "url": "string",
  "createdBy": "string",
  "createdAt": "2026-10-15T09:00:00+01:00",
  "expiresAt": "2026-10-15T09:00:00+01:00",
  "revokedAt": "2026-10-15T09:00:00+01:00",
  "consentedAt": "2026-10-15T09:00:00+01:00",
  "lastUsedAt": "2026-10-15T09:00:00+01:00",
  "active": true
}

Erreurs

default Erreur

Arrêter aussitôt un lien livreur (sa page dit alors qu’il a pris fin)

DELETE https://nways.ng/maps/v1/fleet/links/{linkId}

Paramètres

Nom	Où	Type	Description
`linkId`	chemin	`string`	Obligatoire.

cURL

curl -X DELETE "https://nways.ng/maps/v1/fleet/links/string" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"

JavaScript

const res = await fetch('https://nways.ng/maps/v1/fleet/links/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/links/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Révoqué

Pas de contenu.

Erreurs

default Erreur