Saltar al contenido
DotPay Developers
DocumentaciónReferencia de API
Direcciones

Find Mexican postal candidates

Versión de API 0.0.1
Demostración pública con datos ficticios
Cualquier persona puede consultar o modificar los perfiles de comercios compartidos sin iniciar sesión. Los catálogos son de solo lectura. Usa únicamente datos ficticios, incluidos los contactos, los RFC y las direcciones.
GET
/address-catalogs/{country}/{postal_code}

Validation uses the selected candidate’s full catalog tuple. An exact match validates catalog geography.

Parámetros de ruta

country*string
postal_code*string
Coincidencia^[0-9]{5}$
API-Version?string

Optional. Omit or send latest to resolve 0.0.1.

Predeterminado"0.0.1"
Valor en"0.0.1""latest"

Cuerpo de la respuesta

An unknown postal code returns an empty array.

application/json
  1. 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
curl -X GET 'https://api.dotpay.mx/address-catalogs/MX/01234'
Respuesta de ejemplo
{  "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 completa

Cabeceras 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.

Cabeceras de solicitud
CabeceraRequisitoEsquema
API-Version

Optional. Omit or send latest to resolve 0.0.1.

Opcional{"type":"string","enum":["0.0.1","latest"],"default":"0.0.1"}
Cabeceras de respuesta por estado HTTP
EstadoCabeceraEsquema
200Cache-Control{"type":"string","const":"no-store"}
200API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
200Vary{"type":"string"}

Ejemplo: "API-Version"

400Cache-Control{"type":"string","const":"no-store"}
400API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
400Vary{"type":"string"}

Ejemplo: "API-Version"

406Cache-Control{"type":"string","const":"no-store"}
406API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
406Vary{"type":"string"}

Ejemplo: "API-Version"

500Cache-Control{"type":"string","const":"no-store"}
500API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
500Vary{"type":"string"}

Ejemplo: "API-Version"

503Cache-Control{"type":"string","const":"no-store"}
503API-Version

Present after successful version negotiation.

{"type":"string","const":"0.0.1"}
503Vary{"type":"string"}

Ejemplo: "API-Version"