N-Ways
Documentação para programadoresPreenchimento automático

Preenchimento automático

Sugestões enquanto se escreve, faturadas por sessão.

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

Sugestões à medida que se escreve (faturado por sessão)

GET https://nways.ng/maps/v1/autocomplete

Envie o mesmo token session (8–64 caracteres de A–Z a–z 0–9 - _, um UUID serve) desde a primeira letra até o utilizador escolher um resultado: o primeiro pedido da sessão é faturado (uma sessão autocomplete); os restantes contam para o limite de pedidos mas não são cobrados, até 3 minutos entre pedidos, 15 minutos e 100 pedidos no total. Comece um novo token depois de uma escolha. Sem token, cada pedido é uma sessão. X-NWays-Session-Billed: 1|0 indica qual. Motivos: os de /geocode, e SESSION_INVALID, TYPES_INVALID.

Parâmetros

NomeOndeTipoDescrição
qconsultastringObrigatório.
sessionconsultastring
nearconsultastringlat,lng: ordenar e escolher resultados perto deste ponto.
countryconsultastringLista separada por vírgulas de NG, GH, BJ, TG, GA, CI, LR, GN, SL, GW, SN, CM, BF, CV, GM.
typesconsultastringLista separada por vírgulas de address, street, business, place, area, postcode, ghanapost.
limitconsultaintegerPredefinição: 5. ≥ 1, ≤ 10.
langconsultastringUm de: en, fr, pt. Predefinição: en.
fieldsconsultastringLista separada por vírgulas dos campos a manter em cada resultado (a.b entra em objetos; id é sempre mantido; * = todos).
cURL
curl "https://nways.ng/maps/v1/autocomplete?q=lekki+ph" \
  -H "X-NWays-Api-Key: A_SUA_CHAVE_API"
JavaScript
const res = await fetch('https://nways.ng/maps/v1/autocomplete?q=lekki+ph', {
  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/autocomplete?q=lekki+ph",
    headers={"X-NWays-Api-Key": os.environ["NWAYS_API_KEY"]},
    timeout=10,
)
data = res.json()

Resposta

Sugestões

CampoTipoDescrição
resultsResult[]Obrigatório.
results[].idstringObrigatório.
results[].namestringObrigatório.
results[].typestringObrigatório. address, street, business, landmark, building, postcode, ghanapost, ou uma zona: neighbourhood, suburb, village, town, city, state…
results[].categorystring
results[].locationPointObrigatório.
results[].location.typestringObrigatório.
results[].location.coordinatesnumber[]Obrigatório. [lng, lat] Pelo menos 2 elementos, no máximo 2 elementos.
results[].bboxnumber[]oeste, sul, este, norte (zonas) Pelo menos 4 elementos, no máximo 4 elementos.
results[].formattedAddressstring
results[].postcodestringCódigo postal NIPOST, compacto
results[].ghanaPoststring
results[].plusCodestringObrigatório.
results[].countrystring
results[].distanceMnumberA partir de near (ou do ponto consultado).
results[].estimatedbooleanO ponto é uma estimativa, dentro de accuracyM.
results[].accuracyMnumber
results[].placeIdstringUm negócio: o seu id para /places/{id}.
results[].attributionstring
didYouMeanstring
attributionstringObrigatório.
200 OK
{
  "results": [
    {
      "id": "osm:w568367632",
      "name": "Ikeja City Mall",
      "type": "landmark",
      "category": "shopping",
      "location": {
        "type": "string",
        "coordinates": [
          0
        ]
      },
      "bbox": [
        0
      ],
      "formattedAddress": "Ikeja, Lagos",
      "postcode": "LA08A09DB09",
      "ghanaPost": "GA-183-8164",
      "plusCode": "6FR5J975+P4W",
      "country": "NG",
      "distanceM": 0,
      "estimated": true,
      "accuracyM": 0,
      "placeId": "string",
      "attribution": "string"
    }
  ],
  "didYouMean": "string",
  "attribution": "string"
}

Erros

  • default Erro