N-Ways
Documentation développeursRider app

Rider app

Invitez les livreurs dans N-Ways Business, l’application des entreprises (partage de position en arrière-plan, courses, preuve de livraison).

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 invitations du livreur à N-Ways Business (jamais leurs codes), de la plus récente à la plus ancienne

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

Paramètres

NomOùTypeDescription
idcheminstringObligatoire.
cURL
curl "https://nways.ng/maps/v1/fleet/drivers/string/invites" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/drivers/string/invites', {
  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/drivers/string/invites",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Invitations

ChampTypeDescription
invitesRiderInvite[]Obligatoire.
invites[].idstringObligatoire.
invites[].driverIdstringObligatoire.
invites[].codestringSeulement à la création.
invites[].urlstring (uri)Seulement à la création : https://nways.ng/r/<code>.
invites[].createdBystringObligatoire.
invites[].createdAtstring (date-time)Obligatoire.
invites[].expiresAtstring (date-time)Obligatoire.
invites[].usedAtstring (date-time) | nullObligatoire.
invites[].revokedAtstring (date-time) | nullObligatoire.
invites[].activebooleanObligatoire.
200 OK
{
  "invites": [
    {
      "id": "string",
      "driverId": "string",
      "code": "string",
      "url": "string",
      "createdBy": "string",
      "createdAt": "2026-10-15T09:00:00+01:00",
      "expiresAt": "2026-10-15T09:00:00+01:00",
      "usedAt": "2026-10-15T09:00:00+01:00",
      "revokedAt": "2026-10-15T09:00:00+01:00",
      "active": true
    }
  ]
}

Erreurs

  • default Erreur

Inviter le livreur dans N-Ways Business

POST https://nways.ng/maps/v1/fleet/drivers/{id}/invites

Le code de la réponse (8 caractères, affiché XXXX-XXXX) et l’url (https://nways.ng/r/…) ne sont montrés qu’une fois : envoyez-les au livreur. Sur un téléphone avec N-Ways Business, le lien ouvre l’application ; sinon le livreur l’installe, se connecte avec son compte N-Ways et saisit le code. En rejoignant, le compte du livreur est lié à ce conducteur : l’application partage alors la position du téléphone en arrière-plan pendant son service (pour le véhicule dont driverId est ce conducteur), affiche les courses de ce véhicule et les marque récupérées, livrées ou échouées avec photo ou signature comme preuve. Une nouvelle invitation remplace les précédentes ; chacune ne sert qu’une fois.

Paramètres

NomOùTypeDescription
idcheminstringObligatoire.

Corps de la requête

ChampTypeDescription
daysintegerDurée de validité du code. Par défaut: 7. ≥ 1, ≤ 30.
cURL
curl -X POST "https://nways.ng/maps/v1/fleet/drivers/string/invites" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{"days":7}'
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/drivers/string/invites', {
  method: 'POST',
  headers: { 'X-NWays-Api-Key': process.env.NWAYS_API_KEY, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "days": 7
  }),
})
const data = await res.json()
Python
import os
import requests

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

Réponse

L’invitation avec son code et son url

ChampTypeDescription
idstringObligatoire.
driverIdstringObligatoire.
codestringSeulement à la création.
urlstring (uri)Seulement à la création : https://nways.ng/r/<code>.
createdBystringObligatoire.
createdAtstring (date-time)Obligatoire.
expiresAtstring (date-time)Obligatoire.
usedAtstring (date-time) | nullObligatoire.
revokedAtstring (date-time) | nullObligatoire.
activebooleanObligatoire.
201 OK
{
  "id": "string",
  "driverId": "string",
  "code": "string",
  "url": "string",
  "createdBy": "string",
  "createdAt": "2026-10-15T09:00:00+01:00",
  "expiresAt": "2026-10-15T09:00:00+01:00",
  "usedAt": "2026-10-15T09:00:00+01:00",
  "revokedAt": "2026-10-15T09:00:00+01:00",
  "active": true
}

Erreurs

  • default Erreur

Retirer une invitation (son code ne marche plus)

DELETE https://nways.ng/maps/v1/fleet/invites/{inviteId}

Paramètres

NomOùTypeDescription
inviteIdcheminstringObligatoire.
cURL
curl -X DELETE "https://nways.ng/maps/v1/fleet/invites/string" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/invites/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/invites/string",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Retirée

Pas de contenu.

Erreurs

  • default Erreur

Détacher le compte N-Ways du livreur de ce conducteur

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

L’application cesse aussitôt de partager la position du livreur et d’afficher ses courses. Invitez-le de nouveau pour le faire revenir.

Paramètres

NomOùTypeDescription
idcheminstringObligatoire.
cURL
curl -X DELETE "https://nways.ng/maps/v1/fleet/drivers/string/app" \
  -H "X-NWays-Api-Key: VOTRE_CLE_API"
JavaScript
const res = await fetch('https://nways.ng/maps/v1/fleet/drivers/string/app', {
  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/drivers/string/app",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Réponse

Détaché

Pas de contenu.

Erreurs

  • default Erreur