Ejemplos
- Ejemplo 1 – Dirección con sugerencia de corrección
- Ejemplo 2 – Dirección sin sugerencia de corrección
- Ejemplo 3 – Dirección con varios errores de escritura
- Ejemplo 4 – Complemento enviado en el parámetro number
- Ejemplo 5 – Dirección sin número (s/n)
- Ejemplo 6 – Ciudad que no corresponde al CEP
- Ejemplo 7 – CEP inexistente
Ejemplo 1 – Dirección con sugerencia de corrección
En este ejemplo, la dirección se envía en el formato label, con el tipo de calle abreviado, el CEP con guión y la ciudad sin tilde.
Solicitud
{
"label": "av paulista 1578 museu,,bela vista,01310-200,sao paulo,SP"
}
Respuesta
La respuesta trae la grafía oficial sugerida para la calle, el barrio y la ciudad, con el número y el complemento separados. El status devuelto será CORRECTED.
{
"road": "Avenida Paulista",
"number": "1578",
"complement": "museu",
"district": "Bela Vista",
"zipcode": "01310200",
"city": "São Paulo",
"state": "SP",
"status": "CORRECTED",
"matchScore": 100.0,
"label": "Avenida Paulista, 1578, Bela Vista, 01310200, São Paulo, SP"
}
Ejemplo 2 – Dirección sin sugerencia de corrección
En este ejemplo, la dirección se envía en el formato estructurado y la calle no corresponde al CEP informado.
Solicitud
{
"road": "rua das acacias 45",
"number": "",
"zipcode": "01310200",
"district": "bela vista",
"city": "São Paulo",
"state": "SP"
}
Respuesta
El número se separó de la calle, pero no hay sugerencia de corrección. El status devuelto será NORMALIZED.
{
"road": "rua das acacias",
"number": "45",
"complement": "",
"district": "bela vista",
"zipcode": "01310200",
"city": "São Paulo",
"state": "SP",
"status": "NORMALIZED",
"matchScore": 18.75,
"label": "rua das acacias, 45, bela vista, 01310200, São Paulo, SP"
}
Ejemplo 3 – Dirección con varios errores de escritura
En este ejemplo, la dirección enviada en el formato label tiene el tipo de calle abreviado con punto, un error de escritura en el nombre de la calle, el número pegado al marcador «nº», el complemento separado por guión, el CEP con guión y el barrio y la ciudad sin tildes.
Solicitud
{
"label": "R. da Cantarera nº306 - box 12,,centro,01024-000,sao paulo,SP"
}
Respuesta
La API corrige el nombre de la calle, separa el número y el complemento y devuelve la grafía oficial del barrio y de la ciudad. El status devuelto será CORRECTED.
{
"road": "Rua da Cantareira",
"number": "306",
"complement": "box 12",
"district": "Centro",
"zipcode": "01024000",
"city": "São Paulo",
"state": "SP",
"status": "CORRECTED",
"matchScore": 94.74,
"label": "Rua da Cantareira, 306, Centro, 01024000, São Paulo, SP"
}
Ejemplo 4 – Complemento enviado en el parámetro number
En este ejemplo, la dirección se envía en el formato estructurado y el parámetro number contiene el número seguido del complemento.
Solicitud
{
"road": "av paulista",
"number": "1578 museu masp",
"zipcode": "01310200",
"district": "bela vista",
"city": "sao paulo",
"state": "SP"
}
Respuesta
El texto después del número se devuelve en complement, y number queda solo con el número. El status devuelto será CORRECTED.
{
"road": "Avenida Paulista",
"number": "1578",
"complement": "museu masp",
"district": "Bela Vista",
"zipcode": "01310200",
"city": "São Paulo",
"state": "SP",
"status": "CORRECTED",
"matchScore": 100.0,
"label": "Avenida Paulista, 1578, Bela Vista, 01310200, São Paulo, SP"
}
Ejemplo 5 – Dirección sin número (s/n)
En este ejemplo, la dirección enviada en el formato label indica que el inmueble no tiene número («s/n») y trae una referencia después de la calle.
Solicitud
{
"label": "rua augusta s/n esquina com al santos,,consolacao,01305-000,sao paulo,SP"
}
Respuesta
number se devuelve vacío y la referencia se devuelve en complement. El status devuelto será CORRECTED.
{
"road": "Rua Augusta",
"number": "",
"complement": "esquina com al santos",
"district": "Consolação",
"zipcode": "01305000",
"city": "São Paulo",
"state": "SP",
"status": "CORRECTED",
"matchScore": 100.0,
"label": "Rua Augusta, , Consolação, 01305000, São Paulo, SP"
}
Ejemplo 6 – Ciudad que no corresponde al CEP
En este ejemplo, la dirección se envía en el formato estructurado con un CEP de São Paulo, pero con la ciudad y el estado de Río de Janeiro.
Solicitud
{
"road": "av paulista 1578",
"number": "",
"zipcode": "01310-200",
"district": "bela vista",
"city": "rio de janeiro",
"state": "RJ"
}
Respuesta
Como la ciudad no corresponde al CEP informado, no hay sugerencia de corrección: la dirección solo se estandariza, con el número separado de la calle. El status devuelto será NORMALIZED.
{
"road": "avenida paulista",
"number": "1578",
"complement": "",
"district": "bela vista",
"zipcode": "01310200",
"city": "rio de janeiro",
"state": "RJ",
"status": "NORMALIZED",
"matchScore": 0.0,
"label": "avenida paulista, 1578, bela vista, 01310200, rio de janeiro, RJ"
}
Ejemplo 7 – CEP inexistente
En este ejemplo, la dirección se envía en el formato estructurado con un CEP que no existe.
Solicitud
{
"road": "rua das flores 120 apto 32",
"number": "",
"zipcode": "99999-999",
"district": "centro",
"city": "sao paulo",
"state": "SP"
}
Respuesta
Como el CEP no fue encontrado, no hay sugerencia de corrección. El número y el complemento se separan de la calle y el status devuelto será NORMALIZED.
{
"road": "rua das flores",
"number": "120",
"complement": "apto 32",
"district": "centro",
"zipcode": "99999999",
"city": "sao paulo",
"state": "SP",
"status": "NORMALIZED",
"matchScore": 0.0,
"label": "rua das flores, 120, centro, 99999999, sao paulo, SP"
}