Ligações para estafetas

Nesta página

As ligações de estafeta do veículo (nunca os seus endereços), das mais recentes para as mais antigas
Uma ligação que um estafeta abre no telemóvel para partilhar a posição deste veículo (sem precisar de aplicação)
Parar de imediato uma ligação de estafeta (a sua página passa a indicar que terminou)

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

As ligações de estafeta do veículo (nunca os seus endereços), das mais recentes para as mais antigas

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

Parâmetros

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

cURL

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

Resposta

Ligações

Campo	Tipo	Descrição
`links`	`RiderLink[]`	Obrigatório.
`links[].id`	`string`	Obrigatório.
`links[].vehicleId`	`string`	Obrigatório.
`links[].url`	`string (uri)`	Apenas quando é criado: https://nways.ng/d/<token>.
`links[].createdBy`	`string`	Obrigatório.
`links[].createdAt`	`string (date-time)`	Obrigatório.
`links[].expiresAt`	`string (date-time)`	Obrigatório.
`links[].revokedAt`	`string (date-time) \| null`	Obrigatório.
`links[].consentedAt`	`string (date-time) \| null`	Obrigatório. Quando o estafeta aceitou partilhar.
`links[].lastUsedAt`	`string (date-time) \| null`	Obrigatório.
`links[].active`	`boolean`	Obrigatório.

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

Erros

default Erro

Uma ligação que um estafeta abre no telemóvel para partilhar a posição deste veículo (sem precisar de aplicação)

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

O url da resposta (https://nways.ng/d/…) é mostrado uma única vez: envie-o ao estafeta. A página pede o acordo do estafeta e depois partilha a posição do telemóvel enquanto está aberta e a partilha está ligada, mostra as suas entregas em aberto e permite marcar uma como recolhida ou entregue. As posições contam como POST /locations para este veículo.

Parâmetros

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

Corpo do pedido

Campo	Tipo	Descrição
`days`	`integer`	Durante quanto tempo a ligação funciona. Predefinição: `30`. ≥ 1, ≤ 90.

cURL

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

Resposta

A ligação com o seu url

Campo	Tipo	Descrição
`id`	`string`	Obrigatório.
`vehicleId`	`string`	Obrigatório.
`url`	`string (uri)`	Apenas quando é criado: https://nways.ng/d/<token>.
`createdBy`	`string`	Obrigatório.
`createdAt`	`string (date-time)`	Obrigatório.
`expiresAt`	`string (date-time)`	Obrigatório.
`revokedAt`	`string (date-time) \| null`	Obrigatório.
`consentedAt`	`string (date-time) \| null`	Obrigatório. Quando o estafeta aceitou partilhar.
`lastUsedAt`	`string (date-time) \| null`	Obrigatório.
`active`	`boolean`	Obrigatório.

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
}

Erros

default Erro

Parar de imediato uma ligação de estafeta (a sua página passa a indicar que terminou)

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

Parâmetros

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

cURL

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

Resposta

Revogada

Sem conteúdo.

Erros

default Erro