Servicios
:logo-adw:Volver al sitio web
Bienvenido a la documentación de AddressWorld. Address World es una plataforma empresarial que simplifica la gestión de datos de direcciones domiciliarias, con servicios personalizables de validación, geocodificación, búsqueda masiva y auto-completado, entre otros.
<aside> ℹ️
El uso de la API requiere credenciales y autenticación para obtener un token, el cual se utiliza en todas las llamadas. Si no dispones de credenciales, debes solicitarlas al correo de soporte.
</aside>
La URL base para enviar todas las solicitudes de API es https://app.address-world.com. Se requiere HTTPS para todas las solicitudes de API.
La API de AddressWorld sigue las convenciones RESTful en la medida de lo posible. Los cuerpos de solicitud y respuesta se codifican como JSON.
Servicio de obtención de token y visualización de información usuario
Busca una dirección de forma individual
Búsqueda directa (Create Direct Geocode v3)
Búsqueda masiva de múltiples direcciones, junto a servicios para crear la solicitud de búsqueda, consultar estado de la solicitud y descarga de la respuesta
Los códigos de respuesta HTTP se usan para indicar clases generales de éxito y error.
| TIPO | Código Estado | Mensaje | Detalle | Descripción |
|---|---|---|---|---|
| Éxito | 200 | Success | Solicitud procesada con éxito. | |
| Error | 400 | Bad Request | Request is not valid! (Input parameter validation failed. Suggestions: missing mandatory parameters) |
Algunos de los parámetros obligatorios no fueron definidos |
| Error | 401 | Unauthorized | Unauthorized. apiKey/token invalid or not found. |
Se requiere un access_token válido para autenticar la consulta |
| Error | 403 | Forbidden | Not allowed |
|
| Error | 405 | Method Not Allowed | Method Not Allowed |
|
| Error | 429 | Too Many Requests | Too Many Requests |
La solicitud fue denegada debido al límite de frecuencia |
| Error | 500 | Internal server error |
Hubo un error interno del sistema. En caso de presentarse por favor reportarlo a [email protected] |
Versionado semántico (SemVer) y fijación de versión (/v{N}).
Algunos endpoint pudieran manejar más de una versión publicada en simultáneo. En este caso, se diferenciarán en la url con un número que identifica la versión.
Esquema: MAJOR.MINOR.PATCH.