N-Ways
Documentação para programadoresCódigos de casa (Benim)

Códigos de casa do Benim

Cada lote do Benim tem um código de casa N-Ways. Consulte um, encontre o código num ponto ou descodifique-o offline com o motor aberto, e cite o N-Ways onde o mostrar.

Nesta página

O que é um código

Cada lote do Benim tem um código de casa N-Ways: o nome curto do seu bairro ou aldeia e um número de quatro ou cinco algarismos, como Cadjéhoun 1807 ou Sainte Rita 12403. 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: Cadjéhoun · 18 07, também sem ponto nem espaço (Cadjéhoun 1807); cinco algarismos lidos como um par e uma centena (Sainte Rita · 12 403). Maiúsculas ou minúsculas e as grafias habituais (Gbèdji = Gbédji, Ouèssè = Wèssè), o nome oficial em vez do nome curto, e a comuna depois de uma vírgula, se quiser (Agata 1500, Cotonou; uma comuna que contradiz o código é recusada). As pessoas nunca veem nem escrevem um algarismo de controlo.
  • Forma máquina, para sistemas, códigos QR e ligações: BJ-COT-12-001-1807-4 (a comuna, o arrondissement, o bairro, 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: COT 12 · 35G 2PX (forma máquina BJ-COT-12-S-35G2PX), uma quadrícula de 3 m da zona UTM 31N enquadrada no seu arrondissement; cada ficha traz também o Plus Code do seu portão (6FR4995R+7CQ).

Em Cotonou, a rua oficial vem primeiro, em officialAddress com "coverage": "official-street"; um número de porta do plano de endereçamento de 2013 ocupa o seu lugar assim que for conhecido. Não é precisa nenhuma comuna nem arrondissement 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-benin. O livro branco explica cada regra.

Nota:

Cite o N-Ways sempre que mostrar um código. Mostre «Código de casa por N-Ways Addressing» junto dos códigos na sua aplicação e cite «N-Ways Addressing for Benin, © N-WAYS LIMITED (nways.ng)» com uma ligação para o repositório no 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.

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
curl "https://map.nways.ng/v1/homecodes/BJ-COT-12-001-1807-4"
200 OK
{
  "country": "BJ",
  "home": "Cadjéhoun 1807",
  "machine": "BJ-COT-12-001-1807-4",
  "check": 4,
  "name": "Cadjéhoun",
  "coverage": "official-street",
  "officialAddress": "Rue 12.202, Cotonou",
  "nameProvisional": false,
  "municipality": "Cotonou",
  "fullLine": "Cadjéhoun · 18 07",
  "spoken": "Cadjéhoun, 18 07",
  "status": "provisional",
  "issued": "bulk",
  "entrance": { "lat": 6.3582212, "lng": 2.3911161, "kind": "centre", "source": "map" },
  "location": { "lat": 6.3582212, "lng": 2.3911161 },
  "plusCode": "6FR4995R+7CQ",
  "lote": { "class": "residential", "coverage": "official-street", "enclosed": false, "floorAreaM2": 280.6, "kind": "building", "official": "Rue 12.202, Cotonou", "rule": "single", "structures": 1, "use": "residential" },
  "credit": "N-Ways Addressing for Benin, © N-WAYS LIMITED (nways.ng)",
  "creditUrl": "https://github.com/n-ways/open-addresses-benin"
}
CampoDescrição
home, machineAs formas memorizada e máquina. Mostre home (ou fullLine) às pessoas; guarde machine.
fullLineO código tal como se diz e se pinta: Cadjéhoun · 18 07.
checkO algarismo de controlo da forma máquina, para sistemas; nunca o mostre às pessoas.
officialNameO nome completo da zona, em letra pequena. Ausente quando é igual a name.
coverage, officialAddressEm Cotonou, official-street e a rua oficial a menos de 30 m: mostre-a primeiro, com o código ao lado.
nameProvisionalA comuna ainda pode escolher o nome curto. O número nunca muda; o nome pode mudar uma vez, e o antigo continua válido.
municipalityA comuna. Uma referência obtida da posição, nunca necessária para descodificar.
statusprovisional, confirmed (os moradores confirmaram) ou retired (já não há casa; o número nunca é reutilizado).
entrance, location, plusCodePara onde ir: o portão quando está no mapa, senão o edifício principal, com o seu Plus Code.
lote, structuresO perfil do lote e de cada edifício: classe, tamanho, pisos quando se conhecem, estado, cada um com a sua fonte. Uma casa nunca traz 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 nenhuma zona tem, um número fora de qualquer bloco do seu nome, uma comuna que contradiz o código).

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
curl "https://map.nways.ng/v1/homecodes/at?lat=6.35822&lng=2.39112"

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/bj_engine.py find "Cadjéhoun 18 07". 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 comuna.

Aloje-os você mesmo

Pode servir os códigos do Benim 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-benin
cd open-addresses-benin/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 Benin, © 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.