Valida y normaliza una dirección completa. Devuelve una dirección
corregida, un veredicto de entregabilidad (DQECodeDetail),
y opcionalmente un desglose de qué campos fueron ajustados.
Solicitud
Se admiten los métodos GET y POST.
l'église
→ l%27%C3%A9glise.
Ejemplos de cURL
Francia - con Modification=O y Version=1.1
Internacional - Italia
Envíe todos los parámetros en el cuerpo de la solicitud
usando Content-Type: application/x-www-form-urlencoded.
La dirección del servidor permanece en la URL.
Ejemplo de cURL
Francia - dirección completa con indicador Modification
Parámetros
| Parámetro | Valor | Descripción | Obl. / Opc. |
|---|---|---|---|
| Licence |
{LICENCE_CODE}
|
Su clave de licencia DQE o token OAuth2. Contacte con soporte si aún no dispone de una. | Obligatorio |
| Adresse |
{INPUT}
|
Cadena de dirección separada por barras verticales (pipes).
Las cinco barras son obligatorias incluso cuando los
campos están vacíos. Para Francia, se puede anteponer un
sexto segmento para el punto de entrega (apartamento,
piso, buzón).
dirección adicional|dirección|localidad dependiente o estado|código postal|ciudad
Ejemplo: |
Obligatorio |
| Pays |
{COUNTRY_CODE}
|
Código de país ISO 3166-1 alfa-3 para el ámbito de
búsqueda de la dirección. Ejemplo: FRA o GBR.
|
Obligatorio |
| Taille |
{LENGTH}
|
Límite de caracteres para el campo de respuesta
Adresse. Se aplica únicamente a direcciones
con caracteres latinos. Valor predeterminado: 38.
Mínimo recomendado: 32.
|
Opcional |
| Instance |
{INSTANCE}
|
No se devuelve en los resultados de este endpoint - se puede omitir sin problema. | Opcional |
| Proposition |
{PROP}
|
Solo para Francia. Controla cómo se devuelven los
resultados de corrección.O - El registro "1" contiene
el resultado de corrección estándar. Si la dirección
no se puede asociar de forma única, se devuelven
sugerencias adicionales como registros "2" a "n".S - El registro "1" devuelve
la dirección introducida tal cual, con su estado de
validación (sin corregir). Si se encuentra una corrección
clara, se devuelve como registro "2". Activa
automáticamente Modification=O.
|
Opcional |
| Modification |
O
|
Valor fijo O. Añade
Code_Modification y
Status_Modification a la respuesta,
indicando qué campos de la dirección fueron ajustados
(dirección adicional, dirección, localidad dependiente,
código postal o ciudad). Consulte
Code_Modification.
|
Opcional |
| Version |
{VERSION}
|
1.1 - Añade campos de calidad de
geocodificación (LibelleQualiteGeo, CodeQualiteGeo)
a la respuesta (solo Francia, requiere suscripción
- contacte con su gestor de cuenta DQE para activarla).2 - Devuelve datos adicionales de la
dirección en un campo ListeComplement.
|
Opcional |
| Segmentation |
O
|
Solo Francia. Requiere suscripción Finesis -
contacte con su gestor de cuenta DQE para activarla.
Establézcalo en O para añadir Sprofil,
Sportrait, Ssegment
(campos de segmentación poblacional) a la respuesta.
Valor predeterminado: N.
|
Opcional |
Campos de la respuesta
La respuesta es un objeto JSON con una única clave "1"
cuyo valor es un diccionario de campos de dirección. Cuando
Proposition=O, se pueden devolver varios registros
numerados.
| Clave | Descripción | Francia | Internacional |
|---|---|---|---|
| DQECodeDetail | Código de resultado de la validación. Consulte Códigos DQECodeDetail más abajo. | String (2) | String (2) |
| DQELibErreur |
Etiqueta de resultado de la validación en texto simple
(OK o una descripción del error).
|
String (38) | String (38) |
| Adresse | Línea de dirección normalizada (número, tipo y nombre de la calle). | String (38) | String (50) |
| Voie | Nombre de la calle sin número ni tipo. | String (38) | String (50) |
| TypeVoie |
Tipo de vía (por ejemplo, RUE, AVENUE,
BOULEVARD).
|
String (20) | String (20) |
| Numero | Número de calle completo, incluyendo cualquier complemento (bis, ter, etc.). | String (10) | String (10) |
| NumSeul | Solo el número de calle, sin ningún complemento (bis, ter, etc.). | String (10) | String (10) |
| CompNum | Complemento del número de calle (bis, ter, etc.). | String (38) | String (50) |
|
NbNumero también: Nbnumero |
Cuando el número consultado no se encuentra o falta, devuelve el número total de números de calle válidos para esta calle. Puede ser una cadena vacía en algunas direcciones internacionales donde este dato no está disponible. | String | String |
| ListeNumero | Lista separada por punto y coma de todos los números válidos en esta calle. Se completa cuando el número enviado no es válido o está ausente. | String (1024) | String (1024) |
| CodePostal | Código postal. | String (5) | String (10) |
| Localite | Nombre de la ciudad. | String (38) | String (50) |
| LieuDit | Localidad con nombre propio o aldea (Francia) o campo equivalente a nivel de distrito (internacional). La disponibilidad varía según el país. | String (38) | String (50) |
| Cedex |
Indicador CEDEX: 1 = dirección CEDEX,
0 = no CEDEX.
|
String (1) | String (1) |
| Ligne2 | Información adicional de la línea 2 de la dirección. | String (38) | String (38) |
| Complement | Información adicional de la dirección (nombre del edificio, piso, etc.). | String (1024) | String (150) |
| ListeComplement |
Lista separada por punto y coma de los complementos de
dirección disponibles (edificios, residencias, etc.)
para la calle encontrada. Se devuelve cuando Version=2.
|
String (1024) | String (1024) |
| IDLocalite | Identificador único de la ciudad (código INSEE para Francia). | String (20) | String (20) |
|
IDVoie o CodeVoie |
Identificador único de la calle. | String (20) | String (20) |
| Pays | Código de país ISO 3166-1 alfa-3. | String (3) | String (3) |
| Province | Código ISO del estado o región administrativa. |
Siempre "*"
|
String (50) |
| Region1 | Etiqueta del estado o región. | No disponible | String |
| Region2 | Condado o nivel administrativo equivalente. | No disponible | String |
| Region3 | Condado o equivalente (nivel alternativo). | No disponible | String |
| Region4 | Información regional o administrativa adicional. | No disponible | String |
| Thoroughfare | Calle dependiente. | No disponible | Solo Reino Unido |
| Roudis | Código de enrutamiento Roudis. Solo Francia. | String (5) | No disponible |
| IDHexaposte | Identificador postal de la ciudad (código Hexaposte para Francia). | String (6) | No disponible |
| IDCle | Identificador único del número de calle (Hexaclé para Francia). | String (10) | No disponible |
| Latitude | Geocoordenadas de la dirección encontrada. No disponible para todos los países - consulte la cobertura. | String | String |
| Longitude | Geocoordenadas de la dirección encontrada. No disponible para todos los países - consulte la cobertura. | String | String |
| Status_IrisIlot | Origen de los códigos IRIS e Ilot. Requiere suscripción - contacte con su gestor de cuenta DQE para activarla. | String (5) | No disponible |
| iris | Código de unidad estadística IRIS. Solo Francia, requiere suscripción - contacte con su gestor de cuenta DQE para activarla. | String (9) | No disponible |
| ilot | Código Ilot. Requiere suscripción - contacte con su gestor de cuenta DQE para activarla. | String | No disponible |
| Instance | Campo interno. | String (3) | String (3) |
| LibelleQualiteGeo |
Etiqueta de calidad de geocodificación (por ejemplo,
ENTREE, BATIMENT). Se completa
cuando Version=1.1. Consulte
Calidad de geocodificación.
|
String | No disponible |
| CodeQualiteGeo |
Código numérico de calidad de geocodificación. Se
completa cuando Version=1.1.
|
String | No disponible |
| Sprofil |
Perfil poblacional (Finesis). Se devuelve cuando
Segmentation=O.
|
String (10) | No disponible |
| Sportrait |
Retrato poblacional (Finesis). Se devuelve cuando
Segmentation=O.
|
String (10) | No disponible |
| Ssegment |
Segmento poblacional (Finesis). Se devuelve cuando
Segmentation=O.
|
String (10) | No disponible |
| Code_Modification |
Cadena binaria de 5 caracteres que indica qué campos
de la dirección fueron ajustados. Se devuelve cuando
Modification=O. Consulte
Code_Modification.
|
String (5) | String (5) |
| Status_Modification |
O si al menos un campo fue ajustado,
N en caso contrario. Se devuelve cuando
Modification=O.
|
String (1) | String (1) |
|
DQECompte DQECodeErreur DQEPourcentErreur |
Campos heredados que se mantienen por compatibilidad con integraciones antiguas. No utilizar en nuevas implementaciones. | String | No disponible |
Se devuelve
con Version=1.1
Se devuelve
con Segmentation=O
Se devuelve
con Modification=O
Ejemplos de respuesta
|1 Rue de la Louisiane||31200|Toulouse
Códigos DQECodeDetail
DQECodeDetail es el indicador principal del
resultado de la validación. Utilícelo para determinar qué
acción realizar al enviar el formulario.
Para conocer los mensajes de interfaz recomendados asociados
a cada código, consulte la
Guía de integración.
| Código | Descripción |
|---|---|
| 10 | Dirección correcta |
| 20 | Dirección correcta (calle no reconocida, pero es una dirección CEDEX o apartado de correos) |
| 21 | Población pequeña, número de calle fuera de rango |
| 22 | Población pequeña, falta el número de calle (el resto de la dirección es correcto) |
| 23 | Ciudad grande, número de calle fuera de rango |
| 24 | Ciudad grande, falta el número de calle (el resto de la dirección es correcto) |
| 25 | Dirección CEDEX desconocida para CEDEXA (si CEDEXA está activo) |
| 30 | Población pequeña, calle no reconocida |
| 31 | Población pequeña - calle no reconocida o ausente; información del distrito reconocida pero insuficiente para determinar la calle. Solo Francia. |
| 40 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 41 | Población pequeña, falta la calle |
| 50 | Ciudad grande, calle no reconocida |
| 51 | Ciudad grande, calle no reconocida o ausente (información del distrito reconocida pero insuficiente para determinar la calle). Solo Francia. |
| 60 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 61 | Ciudad grande, falta la calle |
| 70 | Código postal / ciudad no coinciden - calle presente |
| 71 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 80 | Código postal / ciudad no coinciden - falta la calle |
| 81 | Bloque de dirección de entrada vacío. No se devuelve para Francia. |
| 90 | Dirección internacional detectada - el código de país introducido no parece coincidir con la dirección introducida. |
| 95 | Código de país ausente o incorrecto |
31 y
51 indican que se ha reconocido un distrito:
una zona geográfica identificada por el motor (por ejemplo,
una aldea o urbanización) que no se puede asociar a una
calle específica. Estos códigos son exclusivos de Francia.
DQECodeDetail - ejemplos de entrada
Ejemplos de entradas que producen cada código. Los campos no indicados se dejan vacíos.
| Código | Francia | Internacional |
|---|---|---|
| 10 | |20 rue Jean-Baptiste Pigalle||75009|Paris |
Albert Buildings|3 Scott Drive||WA15 8AB|ALTRINCHAMGBR |
| 20 | |RUE DES FRERES LUMIERE|BP 30036|33564|CARBON BLANC |
- |
| 21 | |26 route du chardonnay||24130|Ginestet |
|Seulestraat 200||8950|HeuvellandBEL |
| 22 | |route du chardonnay||24130|Ginestet |
|Seulestraat||8950|HeuvellandBEL |
| 23 | |13 rue Jean-Baptiste Pigalle||75009|Paris |
|Rue Victor Hugo 235||7012|MonsBEL |
| 24 | |rue Jean-Baptiste Pigalle||75009|Paris |
|Rue Victor Hugo||7012|MonsBEL |
| 25 | |||82016|Montauban CEDEX |
- |
| 30 | |rue Jean-Baptiste Pigalle||24130|Ginestet |
|Via del lungo||70011|AlberobelloITA |
| 31 | |SAINT SYMPHORIEN||12490|VIALA DU TARN |
No se devuelve fuera de Francia |
| 40 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 41 | |||24130|Ginestet |
|||70011|AlberobelloITA |
| 50 | |route du chardonnay||75009|Paris |
|STREET ABCD||60607|CHICAGOUSA |
| 51 | |Lotissement Casella||20243|PRUNELLI DI FIUMORBO |
No se devuelve fuera de Francia |
| 60 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 61 | |||75009|Paris |
|||60607|CHICAGOUSA |
| 70 | |rue de la mairie||75009|Bordeaux |
|FRANKLIN GTWY SE||00067|MARIETTAUSA |
| 71 | No se espera en los despliegues cloud actuales. Definido por compatibilidad. | No se espera en los despliegues cloud actuales. Definido por compatibilidad. |
| 80 | |||75009|Bordeaux |
|||00067|MARIETTAUSA |
| 81 | No se devuelve para Francia | |||| |
| 90 |
|7C avenue Monbijou||4960|MalmedyPays: FRA - la dirección parece no ser francesa |
- |
| 95 | - | - |
Code_Modification
Se devuelve cuando se añade Modification=O a la solicitud. Status_Modification es O si se ajustó algún campo, N en caso contrario. Code_Modification es una cadena binaria de 5 caracteres, una posición por cada campo de la dirección. 1 = ajustado por DQE, 0 = sin cambios.
| Code_Modification | Significado |
|---|---|
00000 |
Ningún campo ajustado - dirección aceptada tal como se envió. |
11111 |
Los cinco campos ajustados. |
00011 |
Código postal y ciudad ajustados; el resto de campos sin cambios. |
01111 |
Dirección, localidad dependiente, código postal y ciudad ajustados; dirección adicional sin cambios. |
10000 |
Solo se ajustó la dirección adicional. |
01000 |
Solo se ajustó la línea de dirección. |
00100 |
Solo se ajustó la localidad dependiente. |
Status_Modification es O, al menos un campo fue modificado por DQE. Muestre la corrección al usuario mediante una ventana emergente, conservando siempre la opción de mantener su entrada original.Calidad de geocodificación
Cuando se establece Version=1.1 y se dispone de suscripción de geocodificación, se añaden dos campos: LibelleQualiteGeo (etiqueta) y CodeQualiteGeo (código numérico). Solo Francia.
| Código | LibelleQualiteGeo | Descripción |
|---|---|---|
| 1 | ENTREE | Punto de acceso principal a un recinto, conjunto de edificios o parcela (placa de dirección). |
| 2 | BATIMENT | Edificio o parte de un edificio. |
| 3 | ESCALIERS | Hueco de escalera, normalmente dentro de un edificio. |
| 4 | LOGEMENT | Vivienda o habitación dentro de un edificio. |
| 5 | PARCELLE CADASTRALE | Parcela catastral. |
| 6 | SEGMENT DE VOIE | Posición derivada del segmento de calle de conexión. Puede estar fuera del polígono de la ciudad pero en la misma calle. |
| 7 | POINT D ACCESS TECHNIQUE | Punto de acceso técnico (corte de agua, electricidad, gas, etc.). |
| 8 | POINT DELIVRANCE POSTALE | Punto de entrega postal (buzón). |
| 9 | ZONE D ADRESSAGE | Punto ubicado en la localidad dependiente. |
| 10 | CENTRE VILLE | Centro de la ciudad. |
| 0 | CENTRE DE LA VOIE | Punto en el centro de la calle. |
| 90 | A CONTROLER | Calidad de geocodificación incierta - a verificar. |
| 99 | NON PRESENTE | Geocodificación no disponible para esta dirección. |
Errores
A diferencia de las API de sugerencias, RNVP devuelve códigos de error HTTP estándar (no un cuerpo vacío) cuando faltan parámetros obligatorios o son inválidos.
| HTTP | Tipo de error | Cuerpo de la respuesta |
|---|---|---|
| 400 | Ausente o vacío Licence
|
Bad Request Parameters empty fields |
| 401 | Incorrecto Licence
|
unauthorized_client |
| 400 | Ausente o vacío Adresse
|
Bad Request Parameters empty fields |
| 400 | Ausente o vacío Pays
|
Bad Request Parameters empty fields |
| 400 | Valor de parámetro inválido | Bad Request Parameters empty fields |
Probar la API
Haga clic en el botón de abajo para probar este endpoint en directo desde su navegador.
Abrir consola
Ver también
Relacionada con