Códigos de casa da Serra Leoa

O que é um código

Cada lote da Serra Leoa tem um código N-Ways: o nome curto da sua comunidade, cidade ou aldeia e um número de três a cinco algarismos, como Moyamba 15727 ou Connaught 2301. 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 confirmam na aplicação N-Ways.

• Forma memorizada, o que se diz e se escreve: Moyamba 15727, também em grupos (moyamba 157 27). Quaisquer maiúsculas, grafias krio e inglesas (Kissy Tong = Kissy Town), o nome oficial em vez do nome curto (Gbangbatoke Junction 1051 = Gbangbatoke 1051).
• Forma escrita, nas placas e nos formulários: Moyamba 157 27, com o Plus Code do portão. As pessoas nunca veem nem escrevem um dígito de controlo; a API devolve-o em check para os sistemas.
• Forma máquina, para sistemas, códigos QR e ligações: SL-03663-15727 (a zona, o número; SL-03663-15727.2/3 para o edifício 2, unidade 3).
• Código de ponto, para qualquer ponto: o seu Plus Code, 5H68+3V Moyamba ou 6CW95H68+3V, legível por qualquer aplicação de Plus Codes.

Na zona do conselho municipal de Freetown, o Plus Code da propriedade é o endereço oficial: vem primeiro, em officialAddress, com o código N-Ways ao lado. Nenhum distrito, chefado ou bairro faz parte de um código; municipality é deduzido da posição. O modelo, o motor e o registo de todos os códigos são abertos: github.com/n-ways/open-addresses-sierra-leone. O artigo (em inglês) explica cada regra.

Procurar um código

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

curl "https://map.nways.ng/v1/homecodes/SL-03663-15727"

{
  "country": "SL",
  "home": "Moyamba 15727",
  "machine": "SL-03663-15727",
  "check": 0,
  "name": "Moyamba",
  "nameProvisional": false,
  "municipality": "Moyamba District",
  "fullLine": "Moyamba 157 27 · Moyamba District",
  "spoken": "Moyamba, 157 27",
  "status": "provisional",
  "issued": "bulk",
  "entrance": { "lat": 8.1602399, "lng": -12.4327947, "kind": "centre", "source": "map" },
  "location": { "lat": 8.1602399, "lng": -12.4327947 },
  "plusCode": "6CW95H68+3VW",
  "lote": { "use": "residential", "kind": "building", "class": "unknown", "structures": 1, "floorAreaM2": 888.7, "rule": "single" },
  "credit": "N-Ways Addressing for Sierra Leone, © N-WAYS LIMITED (nways.ng)",
  "creditUrl": "https://github.com/n-ways/open-addresses-sierra-leone"
}

Em Freetown, a ficha mostra primeiro o Plus Code do conselho:

{
  "home": "Connaught 2301",
  "machine": "SL-00623-2301",
  "officialName": "Connaught Hospital Community",
  "coverage": "official",
  "officialAddress": "FQQ6+9G Freetown",
  "municipality": "Freetown",
  "fullLine": "Connaught 23 01 · Freetown",
  "lote": { "use": "health", "class": "health", "official": "FQQ6+9G Freetown" }
}

Erros: 400 homecode_format quando o texto não é um código; 404 homecode_unknown com uma mensagem que diz porquê (um nome que nenhuma zona 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 "https://map.nways.ng/v1/homecodes/at?lat=8.16024&lng=-12.43279"

Pesquisa

Um código escrito na pesquisa N-Ways, em qualquer das suas formas, dá 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 lê e escreve Plus Codes, sem rede: python3 engine/reference/sl_address.py decode "Moyamba 157 27". Os seus vetores de conformidade (engine/reference/vectors.json) são o teste da sua própria implementação, engine/data/register.json contém cada zona e os seus blocos fixos, e registry/ cada código emitido, um ficheiro gzip por zona Plus Code de 4 caracteres.

Aloje-os você mesmo

Pode servir os códigos da Serra Leoa 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-sierra-leone
cd open-addresses-sierra-leone
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.