N-Ways
Documentação para programadoresCódigos de casa (Guiné-Bissau)

Códigos de casa da Guiné-Bissau

Cada lote da Guiné-Bissau tem um código N-Ways. 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

Cada lote da Guiné-Bissau, nos 39 setores, tem um código N-Ways: o nome curto do seu bairro, cidade ou tabanca e um número curto, como Bandim 537 ou Gabu 1203. 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.

  • Forma memorizada, a que se diz e se escreve: Bandim 537. Com ou sem maiúsculas, grafias portuguesas e kriol (Sintchã = Sinchã), o nome oficial em vez do nome curto.
  • Forma escrita, nas placas e nos formulários: Bandim 537. 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: 10-022-00537-4 (setor, lugar, número, dígito de controlo).
  • Código de ponto, para qualquer ponto sem lote: 10-4327-9117, calculado offline.

A Guiné-Bissau não tem um sistema de endereços oficial: os seus códigos postais só existem no papel, e apenas 1000 BISSAU está atestado; é mostrado ao lado dos códigos de Bissau, como contexto. O modelo, o motor e o registo de todos os códigos são abertos: github.com/n-ways/open-addresses-guinea-bissau. O artigo 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 na sua aplicação, e credite «N-Ways Addressing for Guinea-Bissau, © 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, escrita ou máquina, ou um código de ponto sobre um lote, codificado para URL. Não é precisa nenhuma chave.

cURL
curl "https://map.nways.ng/v1/homecodes/Bandim%20537"
200 OK
{
  "country": "GW",
  "home": "Bandim 537",
  "machine": "10-022-00537-4",
  "check": 4,
  "name": "Bandim",
  "nameProvisional": false,
  "municipality": "Bissau",
  "postcode": { "value": "1000", "kind": "area", "source": "UPU" },
  "fullLine": "Bandim 537 · Bissau",
  "spoken": "Bandim, quinhentos e trinta e sete",
  "status": "provisional",
  "issued": "bulk",
  "entrance": { "lat": 11.8521485, "lng": -15.5950371, "kind": "centre", "source": "map" },
  "location": { "lat": 11.8521485, "lng": -15.5950371 },
  "plusCode": "7C36VC23+VX4",
  "lote": { "use": "residential", "kind": "building", "class": "residential.compound-house", "structures": 1, "floorAreaM2": 272.4, "settlement": "cidade" },
  "credit": "N-Ways Addressing for Guinea-Bissau, © N-WAYS LIMITED (nways.ng)",
  "creditUrl": "https://github.com/n-ways/open-addresses-guinea-bissau"
}
CampoDescrição
home, machineAs formas memorizada e máquina. Mostre home às pessoas; guarde machine.
check, fullLineO dígito de controlo, só para sistemas, e a forma escrita tal como numa placa, com o setor.
officialNameO nome completo do lugar, em letra pequena (Missirá Ama Sidi para Ama Sidi). Ausente quando é igual a name.
nameProvisionalO setor ou a Câmara ainda tem de escolher o nome curto. O número nunca muda; o nome pode mudar uma vez.
municipality, islandO setor, e a ilha para um lote dos Bijagós ou de outra ilha. Só como contexto: nunca é necessário para descodificar.
postcode1000 em Bissau, o único código postal atestado (UPU, 2005). Só como contexto.
statusprovisional, confirmed (os moradores validaram) ou retired (já não há habitação nesse local; o número nunca é reutilizado).
entrance, locationPara onde ir: o portão quando está cartografado, senão o centro 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 as pessoas que lá vivem.

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=11.85215&lng=-15.59504"

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 os códigos de ponto, sem rede: python3 engine/reference/gw_codes.py "Bandim 537". Os seus vetores de teste (engine/reference/vectors.json) são o teste de conformidade da sua própria implementação, e registry/ contém todos os códigos atribuídos, um ficheiro gzip por setor.

Aloje-os você mesmo

Pode servir os códigos da Guiné-Bissau 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-guinea-bissau
cd open-addresses-guinea-bissau/server
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 Guinea-Bissau, © 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.