N-Ways
Documentação para programadoresCódigos de casa (Costa do Marfim)

Códigos de casa da Costa do Marfim

Cada lote da Costa do Marfim 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 da Costa do Marfim tem um código de casa N-Ways: o nome curto do seu bairro, aldeia ou cité e um número de quatro ou cinco algarismos, como Bonoumin 6136 ou Remblais 2966. 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 se diz e escreve: Bonoumin 6136, também em pares (bonoumin 61 36) ou depois de um ponto (Bonoumin · 61 36). Maiúsculas ou minúsculas e as grafias habituais (Koffikro = Kofikro, Riviéra II = Riviera 2), o nome oficial em vez do nome curto (Koumassi remblais 2966 = Remblais 2966).
  • Forma escrita, nas placas e nos formulários: Bonoumin 61 36 (Cocody). A comuna entre parênteses é apenas uma referência. As pessoas nunca veem nem escrevem um algarismo de controlo.
  • Forma máquina, para sistemas, códigos QR e ligações: CI-010114-083-6136-2 (a unidade, 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: o seu Plus Code, 926H+7Q7 Cocody ou 6CQR926H+7Q7, legível por qualquer aplicação de Plus Codes.

Onde o Estado deu um endereço ao portão (o PADA em Abidjan, mais tarde o PAVI), esse endereço vem primeiro, em officialAddress, com o código N-Ways ao lado. Não é precisa nenhuma comuna nem sous-préfecture 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-cote-divoire. 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 Côte d’Ivoire, © 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, escrita ou máquina, ou o Plus Code de um lote, codificado para URL. Não é precisa chave.

cURL
curl "https://map.nways.ng/v1/homecodes/CI-010114-083-6136-2"
200 OK
{
  "country": "CI",
  "home": "Bonoumin 6136",
  "machine": "CI-010114-083-6136-2",
  "check": 2,
  "name": "Bonoumin",
  "nameProvisional": false,
  "municipality": "Cocody",
  "fullLine": "Bonoumin 61 36 (Cocody)",
  "spoken": "Bonoumin, 61 36",
  "status": "provisional",
  "issued": "bulk",
  "entrance": { "lat": 5.3606529, "lng": -3.9705867, "kind": "centre", "source": "map" },
  "location": { "lat": 5.3606529, "lng": -3.9705867 },
  "plusCode": "6CQR926H+7Q7",
  "lote": { "use": "residential", "kind": "building", "class": "residential", "structures": 1, "floorAreaM2": 77.7, "rule": "single" },
  "credit": "N-Ways Addressing for Côte d'Ivoire, © N-WAYS LIMITED (nways.ng)",
  "creditUrl": "https://github.com/n-ways/open-addresses-cote-divoire"
}
CampoDescrição
home, machineAs formas memorizada e máquina. Mostre home às pessoas; guarde machine.
fullLineA forma escrita com a sua comuna, para placas e formulários.
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, officialAddressOnde o Estado numerou o portão, official e o seu endereço: mostre-o primeiro, com o código ao lado.
nameProvisionalA comuna ainda tem de escolher o nome curto. O número nunca muda; o nome pode mudar uma vez.
municipalityA comuna de Abidjan ou a sous-préfecture. 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, 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=5.36065&lng=-3.97059"

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 Plus Codes, sem rede: python3 engine/reference/ci_engine.py parse "Bonoumin 61 36". Os seus vetores de conformidade (engine/reference/vectors.json) servem de teste à sua própria implementação, engine/data/register.json contém cada unidade, nome e zona com os seus blocos fixos, e registry/ cada código emitido, um ficheiro gzip por unidade.

Aloje-os você mesmo

Pode servir os códigos da Costa do Marfim 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-cote-divoire
cd open-addresses-cote-divoire
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 Côte d’Ivoire, © 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.