N-Ways
Documentação para programadoresCódigos de casa (Gâmbia)

Códigos de casa da Gâmbia

Cada lote da Gâmbia tem um código de casa ao lado do seu Plus Code. Procure um, encontre o código de um ponto ou descodifique-o offline com o motor aberto, e credite o N-Ways onde o mostrar.

Nesta página

O que é um código de casa

Cada lote da Gâmbia, nas 7 zonas, tem um código de casa N-Ways: o nome curto da sua cidade, aldeia ou bairro e um número curto, como Bakau 2389 ou Banjul 19 474. Cada código é único em todo o país por si só e leva ao portão do lote. Os códigos são primeiro provisórios e depois confirmados quando os moradores os validam na aplicação N-Ways.

  • O endereço oficial é o do governo: o Plus Code do portão com a sua cidade, F8HC+9G6 Bakau (Política Nacional de Endereçamento Digital, 2023). Mostre-o primeiro. O endereço de rua de um conselho, se for conhecido, vem antes.
  • Forma memorizada, a que as pessoas dizem e escrevem: Bakau 2389. Maiúsculas, grafias gambianas (Keur = Kerr), com ou sem espaços.
  • Forma escrita, nas placas e nos formulários: BAKAU 2389 · KANIFING (com a zona). As pessoas nunca veem nem escrevem um dígito de controlo; ele só existe na forma máquina.
  • Forma máquina, para sistemas, códigos QR e ligações: GM-KMC-0001-2389-6 (zona, índice do lugar, número, dígito de controlo).

O modelo, o motor e o registo de todos os códigos são abertos: github.com/n-ways/open-addresses-gambia. O artigo (em inglês) explica cada regra.

Nota:

Credite o N-Ways onde quer que mostre um código. Mostre «Código de casa por N-Ways Addressing» junto dos códigos, e cite «N-Ways Addressing for The Gambia, © N-WAYS LIMITED (nways.ng)» com uma ligação para o repositório no seu ecrã «Sobre» ou na sua documentação. O motor está sob Apache 2.0, os dados sob ODbL 1.0 e os documentos sob CC BY 4.0.

Procurar um código

GET https://map.nways.ng/v1/homecodes/{code}, em que code é a forma memorizada ou a forma máquina, codificada para URL. Não é precisa nenhuma chave.

cURL
curl "https://map.nways.ng/v1/homecodes/Bakau%202389"
200 OK
{
  "country": "GM",
  "home": "Bakau 2389",
  "machine": "GM-KMC-0001-2389-6",
  "name": "Bakau",
  "nameProvisional": false,
  "municipality": "Kanifing",
  "coverage": "official",
  "officialAddress": "F8HC+9G6 Bakau",
  "fullLine": "BAKAU 2389 · KANIFING",
  "spoken": "Bakau, twenty-three, eighty-nine",
  "status": "provisional",
  "issued": "bulk",
  "entrance": { "lat": 13.47841, "lng": -16.6787355, "kind": "centre", "source": "map" },
  "location": { "lat": 13.47841, "lng": -16.6787355 },
  "plusCode": "7C55F8HC+9G6",
  "lote": { "use": "residential", "class": "res.maison", "kind": "un_batiment", "structures": 1, "floorAreaM2": 113.1, "enclosed": false },
  "credit": "N-Ways Addressing for The Gambia, © N-WAYS LIMITED (nways.ng)",
  "creditUrl": "https://github.com/n-ways/open-addresses-gambia"
}
CampoDescrição
coverage, officialAddressO endereço oficial, a mostrar primeiro: o Plus Code do governo com a sua cidade, ou o endereço de rua de um conselho, se for conhecido.
home, machineAs formas memorizada e máquina. Mostre home ao lado do endereço oficial; guarde machine.
fullLineA forma escrita, como numa placa: com a zona. O dígito de controlo está em check e na forma máquina, só para sistemas.
officialNameO nome completo do lugar, em letra pequena (Brusubi Phase 1 para Brusubi 1). Ausente quando é igual a name.
nameProvisionalO conselho ainda tem de escolher o nome curto. O número nunca muda; o nome pode mudar uma vez.
statusprovisional, confirmed (os moradores validaram-no) ou retired (já não há habitação; o número nunca é reutilizado).
entrance, locationPara onde ir: o portão, se estiver cartografado, senão o edifício principal do lote.
lote, structuresO perfil do lote e de cada edifício: classe, tamanho, pisos, estado, cada um com a sua fonte. Uma habitação nunca contém nada sobre quem lá vive.

Erros: 400 homecode_format quando o texto não é um código; 404 homecode_unknown com uma mensagem que diz porquê (um nome que nenhum lugar tem, um número fora de todos os blocos, um dígito de controlo errado).

Qual é o código aqui?

GET https://map.nways.ng/v1/homecodes/at?lat=…&lng=… responde para um ponto: "status": "found" com o código, ou "none" onde nenhum lote tem ainda um.

cURL
curl "https://map.nways.ng/v1/homecodes/at?lat=13.4784&lng=-16.6787"

Um código escrito na pesquisa N-Ways, em qualquer das suas formas, encontra o portão do lote como primeiro resultado, com "category": "homecode" e o crédito em attribution.

Descodificar offline

O motor de referência do repositório (Python, apenas a biblioteca padrão) descodifica todas as formas, verifica o dígito de controlo e calcula o Plus Code do governo, sem rede: python3 engine/reference/gm_engine.py find "Bakau 2389". Os seus vetores de teste são o teste de conformidade da sua implementação, e registry/ contém todos os códigos atribuídos, um ficheiro gzip por zona.

Aloje-os você mesmo

Pode servir os códigos da Gâmbia a partir dos seus próprios servidores, sem chamar o N-Ways. O repositório no GitHub contém todos os códigos emitidos (registry/), as zonas dos códigos e o modelo (model/), o motor de referência e um servidor do registo pronto a usar, com a sua API JSON:

Shell
git clone https://github.com/n-ways/open-addresses-gambia
cd open-addresses-gambia
docker compose up -d

O servidor importa o registo no primeiro arranque e depois responde às pesquisas na sua máquina; server/README.md descreve a configuração, as cópias de segurança e as atualizações, e docs/api.md cada ponto de acesso. A sua cópia é só de leitura: os códigos novos vêm de um único emissor por país, o N-Ways salvo se o Estado designar outro, para que nenhum número seja dado duas vezes. Volte a puxar o repositório para obter os códigos emitidos desde então.

O que usaLicençaO que lhe pede
O motor, o servidor e as ferramentasApache 2.0Mantenha a licença e o NOTICE quando os distribuir ou alterar.
Os códigos, as zonas e o modelo (registry/, model/, engine/data/)ODbL 1.0Cite «N-Ways Addressing for The Gambia, © N-WAYS LIMITED (nways.ng)», com ligação para o repositório, onde mostrar os códigos. Uma base de dados feita a partir dos dados e partilhada é partilhada também sob ODbL 1.0.
Os artigos e outros documentos (docs/)CC BY 4.0Cite o N-Ways e diga o que alterou.

Os termos completos, e a linha de crédito dos mapas e conjuntos de dados feitos a partir dos dados (que cita também o OpenStreetMap), estão em LICENSING.md. Pode dizer que o seu produto usa N-Ways Addressing, não que é o N-Ways nem que é aprovado pelo N-Ways.