Find Mexican postal candidates
Versión de API 0.0.1Validation uses the selected candidate’s full catalog tuple. An exact match validates catalog geography.
country*stringpostal_code*string^[0-9]{5}$API-Version?stringOptional. Omit or send latest to resolve 0.0.1.
"0.0.1""0.0.1""latest"An unknown postal code returns an empty array.
application/json- response
items*array<>Ejemplos de solicitud
Elige un lenguaje y copia la solicitud para enviarla a la demostración pública. Usa únicamente datos ficticios.
curl -X GET 'https://api.dotpay.mx/address-catalogs/MX/01234'{ "items": [ { "country": "MX", "postal_code": "01234", "catalog_version": "synthetic-v1", "entry_id": "09:001:0001", "state": { "id": "09", "label": "Entidad de prueba" }, "municipality": { "id": "001", "label": "Municipio de prueba" }, "city": null, "settlement": { "id": "0001", "label": "Colonia Álamo de prueba" } } ]}Detalles del protocolo
- ID de operación
lookupPostalCode- Método y ruta
GET /address-catalogs/{country}/{postal_code}- Acceso
- Acceso público sin autenticación.
Los parámetros, campos obligatorios, restricciones de validación, esquemas de respuesta y ejemplos de error se generan a partir del contrato del backend. Las tablas muestran las cabeceras de solicitud y respuesta declaradas para esta operación.
Consultar la especificación OpenAPI 3.1 completaCabeceras de solicitud
Omite una cabecera opcional para usar el valor predeterminado de su esquema. Para fijar la versión de API, configura la cabecera de versión en tu solicitud.
| Cabecera | Requisito | Esquema |
|---|---|---|
API-VersionOptional. Omit or send latest to resolve 0.0.1. | Opcional | {"type":"string","enum":["0.0.1","latest"],"default":"0.0.1"} |
| Estado | Cabecera | Esquema |
|---|---|---|
200 | Cache-Control | {"type":"string","const":"no-store"} |
200 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
200 | Vary | {"type":"string"}Ejemplo: |
400 | Cache-Control | {"type":"string","const":"no-store"} |
400 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
400 | Vary | {"type":"string"}Ejemplo: |
406 | Cache-Control | {"type":"string","const":"no-store"} |
406 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
406 | Vary | {"type":"string"}Ejemplo: |
500 | Cache-Control | {"type":"string","const":"no-store"} |
500 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
500 | Vary | {"type":"string"}Ejemplo: |
503 | Cache-Control | {"type":"string","const":"no-store"} |
503 | API-VersionPresent after successful version negotiation. | {"type":"string","const":"0.0.1"} |
503 | Vary | {"type":"string"}Ejemplo: |