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
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
| Nom | Où | Type | Description |
|---|---|---|---|
id | chemin | string | Obligatoire. |
curl "https://nways.ng/maps/v1/fleet/drivers/string/invites" \
-H "X-NWays-Api-Key: VOTRE_CLE_API"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()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
| Champ | Type | Description |
|---|---|---|
invites | RiderInvite[] | Obligatoire. |
invites[].id | string | Obligatoire. |
invites[].driverId | string | Obligatoire. |
invites[].code | string | Seulement à la création. |
invites[].url | string (uri) | Seulement à la création : https://nways.ng/r/<code>. |
invites[].createdBy | string | Obligatoire. |
invites[].createdAt | string (date-time) | Obligatoire. |
invites[].expiresAt | string (date-time) | Obligatoire. |
invites[].usedAt | string (date-time) | null | Obligatoire. |
invites[].revokedAt | string (date-time) | null | Obligatoire. |
invites[].active | boolean | Obligatoire. |
{
"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
defaultErreur
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
| Nom | Où | Type | Description |
|---|---|---|---|
id | chemin | string | Obligatoire. |
Corps de la requête
| Champ | Type | Description |
|---|---|---|
days | integer | Durée de validité du code. Par défaut: 7. ≥ 1, ≤ 30. |
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}'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()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
| Champ | Type | Description |
|---|---|---|
id | string | Obligatoire. |
driverId | string | Obligatoire. |
code | string | Seulement à la création. |
url | string (uri) | Seulement à la création : https://nways.ng/r/<code>. |
createdBy | string | Obligatoire. |
createdAt | string (date-time) | Obligatoire. |
expiresAt | string (date-time) | Obligatoire. |
usedAt | string (date-time) | null | Obligatoire. |
revokedAt | string (date-time) | null | Obligatoire. |
active | boolean | Obligatoire. |
{
"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
defaultErreur
Retirer une invitation (son code ne marche plus)
DELETE https://nways.ng/maps/v1/fleet/invites/{inviteId}
Paramètres
| Nom | Où | Type | Description |
|---|---|---|---|
inviteId | chemin | string | Obligatoire. |
curl -X DELETE "https://nways.ng/maps/v1/fleet/invites/string" \
-H "X-NWays-Api-Key: VOTRE_CLE_API"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()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
defaultErreur
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
| Nom | Où | Type | Description |
|---|---|---|---|
id | chemin | string | Obligatoire. |
curl -X DELETE "https://nways.ng/maps/v1/fleet/drivers/string/app" \
-H "X-NWays-Api-Key: VOTRE_CLE_API"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()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
defaultErreur