Códigos de casa do Togo

O que é um código

Cada lote do Togo tem um código de casa N-Ways: o nome curto do seu bairro, aldeia ou cantão e um número de quatro ou cinco algarismos, como Fréau-Jardin 1058 ou Zongo 14198. Cada código é único em todo o país por si só e leva ao portão do lote. Os códigos começam provisórios e passam a confirmados quando os moradores os confirmam na aplicação N-Ways.

• Forma memorizada, a que as pessoas dizem, escrevem e pintam nas placas: Fréau-Jardin 10 58, também sem espaço (Fréau-Jardin 1058) ou com pontos. Maiúsculas ou minúsculas e as grafias habituais (Djanta Copé = Djanta kopé, Lom-Nava = Lom Nava), o nome oficial em vez do nome curto (Adjahun Fiagbe 1017 = Fiagbe 1017). As pessoas nunca veem nem escrevem um algarismo de controlo.
• Forma máquina, para sistemas, códigos QR e ligações: TG-FRJ-1058-2 (a zona, o número e um algarismo de controlo de Damm que deteta qualquer algarismo errado e qualquer troca de dois algarismos vizinhos; .2/1 a seguir para o edifício 2, portão 1).
• Código de ponto, para qualquer ponto: FRJ-54-4R, uma quadrícula de cerca de 3,4 m enquadrada no seu bairro ou cantão; cada ficha traz também o Plus Code do seu portão (6FR346JF+P96).
• Os códigos de rua de Lomé, como 165 AMT, são referências oficiais de ruas, não códigos N-Ways: a API di-lo e nunca os descodifica.

Na antiga comuna de Lomé, a rua oficial vem primeiro, em officialAddress com "coverage": "official-street"; o endereço de entrada do District Autonome du Grand Lomé ocupará o seu lugar assim que for publicado. Não é precisa nenhuma prefeitura nem comuna para descodificar um código; municipality é obtido a partir da posição. O modelo, o motor e o registo de todos os códigos são abertos: github.com/n-ways/open-addresses-togo. O livro branco explica cada regra.

Consultar um código

GET https://map.nways.ng/v1/homecodes/{code}, em que code é a forma memorizada ou máquina, ou o código de ponto de um lote, codificado para URL. Não é precisa chave.

curl "https://map.nways.ng/v1/homecodes/TG-FRJ-1058-2"

{
  "country": "TG",
  "home": "Fréau-Jardin 1058",
  "machine": "TG-FRJ-1058-2",
  "check": 2,
  "name": "Fréau-Jardin",
  "coverage": "official-street",
  "officialAddress": "Rue Mission Tové, Lomé",
  "nameProvisional": false,
  "municipality": "Lomé",
  "fullLine": "Fréau-Jardin 10 58",
  "spoken": "Fréau-Jardin, 10 58",
  "status": "provisional",
  "issued": "bulk",
  "entrance": { "lat": 6.1317765, "lng": 1.2234008, "kind": "centre", "source": "map" },
  "location": { "lat": 6.1317765, "lng": 1.2234008 },
  "plusCode": "6FR346JF+P96",
  "lote": { "use": "residential", "kind": "building", "class": "residential", "structures": 1, "floorAreaM2": 19.5, "rule": "single", "official": "Rue Mission Tové, Lomé" },
  "credit": "N-Ways Addressing for Togo, © N-WAYS LIMITED (nways.ng)",
  "creditUrl": "https://github.com/n-ways/open-addresses-togo"
}

Erros: 400 homecode_format quando o texto não é um código (um código de rua de Lomé é assinalado como tal); 404 homecode_unknown com uma mensagem que diz porquê (um nome que nenhuma zona tem, um número fora de qualquer bloco do seu nome).

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 código.

curl "https://map.nways.ng/v1/homecodes/at?lat=6.13178&lng=1.22340"

Pesquisa

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

Descodificar offline

O motor de referência do repositório (Python, só com a biblioteca padrão) descodifica cada forma, verifica a forma máquina e lê e escreve códigos de ponto, sem rede: python3 engine/reference/tg_engine.py parse "Fréau-Jardin 10 58". Os seus vetores de conformidade (engine/reference/vectors.json) servem de teste à sua própria implementação, engine/data/register.json contém cada zona e cada nome com os seus blocos fixos, e registry/ cada código emitido, um ficheiro gzip por prefeitura.

Aloje-os você mesmo

Pode servir os códigos do Togo 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:

git clone https://github.com/n-ways/open-addresses-togo
cd open-addresses-togo/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.

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.