Aplicação do estafeta

Convide estafetas para a N-Ways Business, a aplicação de telemóvel das empresas (partilha de posição em segundo plano, trabalhos, comprovativo de entrega).

Nesta página

Os convites do estafeta para a N-Ways Business (nunca os seus códigos), dos mais recentes para os mais antigos
Convidar o estafeta para a N-Ways Business
Retirar um convite (o seu código deixa de funcionar)
Desligar a conta N-Ways do estafeta deste motorista

Nota:

Envie a sua chave com key=A_SUA_CHAVE_API no endereço, ou no cabeçalho X-NWays-Api-Key. Chaves de API

Endereço base: https://nways.ng/maps/v1/fleet

Os convites do estafeta para a N-Ways Business (nunca os seus códigos), dos mais recentes para os mais antigos

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

Parâmetros

Nome	Onde	Tipo	Descrição
`id`	caminho	`string`	Obrigatório.

cURL

curl "https://nways.ng/maps/v1/fleet/drivers/string/invites" \
  -H "X-NWays-Api-Key: A_SUA_CHAVE_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()

Resposta

Convites

Campo	Tipo	Descrição
`invites`	`RiderInvite[]`	Obrigatório.
`invites[].id`	`string`	Obrigatório.
`invites[].driverId`	`string`	Obrigatório.
`invites[].code`	`string`	Apenas quando é criado.
`invites[].url`	`string (uri)`	Apenas quando é criado: https://nways.ng/r/<code>.
`invites[].createdBy`	`string`	Obrigatório.
`invites[].createdAt`	`string (date-time)`	Obrigatório.
`invites[].expiresAt`	`string (date-time)`	Obrigatório.
`invites[].usedAt`	`string (date-time) \| null`	Obrigatório.
`invites[].revokedAt`	`string (date-time) \| null`	Obrigatório.
`invites[].active`	`boolean`	Obrigatório.

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
    }
  ]
}

Erros

default Erro

Convidar o estafeta para a N-Ways Business

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

O code (8 caracteres, mostrado como XXXX-XXXX) e o url (https://nways.ng/r/…) da resposta são mostrados uma única vez: envie-os ao estafeta. Num telemóvel com a N-Ways Business, a ligação abre a aplicação; caso contrário, o estafeta instala-a, inicia sessão com a sua conta N-Ways e escreve o código. Ao aderir, a conta do estafeta fica ligada a este motorista: a aplicação passa a partilhar a posição do telemóvel em segundo plano enquanto o estafeta está de serviço (para o veículo cujo driverId é este motorista), mostra as tarefas desse veículo e marca-as como recolhidas, entregues ou falhadas com prova por fotografia ou assinatura. Um novo convite substitui os anteriores do estafeta; cada um funciona uma única vez.

Parâmetros

Nome	Onde	Tipo	Descrição
`id`	caminho	`string`	Obrigatório.

Corpo do pedido

Campo	Tipo	Descrição
`days`	`integer`	Durante quanto tempo o código funciona. Predefinição: `7`. ≥ 1, ≤ 30.

cURL

curl -X POST "https://nways.ng/maps/v1/fleet/drivers/string/invites" \
  -H "X-NWays-Api-Key: A_SUA_CHAVE_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()

Resposta

O convite com o seu code e url

Campo	Tipo	Descrição
`id`	`string`	Obrigatório.
`driverId`	`string`	Obrigatório.
`code`	`string`	Apenas quando é criado.
`url`	`string (uri)`	Apenas quando é criado: https://nways.ng/r/<code>.
`createdBy`	`string`	Obrigatório.
`createdAt`	`string (date-time)`	Obrigatório.
`expiresAt`	`string (date-time)`	Obrigatório.
`usedAt`	`string (date-time) \| null`	Obrigatório.
`revokedAt`	`string (date-time) \| null`	Obrigatório.
`active`	`boolean`	Obrigatório.

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
}

Erros

default Erro

Retirar um convite (o seu código deixa de funcionar)

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

Parâmetros

Nome	Onde	Tipo	Descrição
`inviteId`	caminho	`string`	Obrigatório.

cURL

curl -X DELETE "https://nways.ng/maps/v1/fleet/invites/string" \
  -H "X-NWays-Api-Key: A_SUA_CHAVE_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()

Resposta

Retirado

Sem conteúdo.

Erros

default Erro

Desligar a conta N-Ways do estafeta deste motorista

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

A aplicação deixa de imediato de partilhar a posição do estafeta e de mostrar os seus trabalhos. Convide-o de novo para o trazer de volta.

Parâmetros

Nome	Onde	Tipo	Descrição
`id`	caminho	`string`	Obrigatório.

cURL

curl -X DELETE "https://nways.ng/maps/v1/fleet/drivers/string/app" \
  -H "X-NWays-Api-Key: A_SUA_CHAVE_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()

Resposta

Desligado

Sem conteúdo.

Erros

default Erro