Catálogos

En los ejemplos, {{auto_financing_base_url}} representa la URL base de Auto Financing del entorno seleccionado.

Información de código postal

Información de la solicitud

Método HTTP	URL	Ejemplo
GET	{{auto_financing_base_url}}/api/catalogs/zip-code/{{zip-code}}	https://stg-api.creditas.io/mx/b2b/autofin/api/catalogs/zip-code/09440

{{zip-code}} es una cadena de cinco dígitos. Por ejemplo: “09440”.

Estado de respuesta

El servicio responde con 200 OK y el siguiente cuerpo.

Cuerpo de la respuesta

Campo	Tipo	Descripción
zipCode	String	Código postal enviado en la solicitud.
neighborhoods	String[]	Lista de colonias asociadas al código postal. Ej.: [“El Retoño”,“San Andrés Tetepilco”,“Zacahuitzco”]
municipality	String	Municipio asociado al código postal.
city	String	Ciudad asociada al código postal.
state	Object	Estado de México asociado al código postal.

Ejemplo con cURL

curl --location --request GET '{{auto_financing_base_url}}/api/catalogs/zip-code/{{zip-code}}' \
--header 'Authorization: Bearer {{access_token}}'

Ejemplo de respuesta

{
    "zipCode": "09440",
    "neighborhoods": [
        "El Retoño",
        "San Andrés Tetepilco",
        "Zacahuitzco"
    ],
    "municipality": "Iztapalapa",
    "city": "Ciudad de México",
    "state": {
        "id": "CDMX",
        "name": "Ciudad de México"
    }
}

Posibles errores

Consulta los posibles errores aquí.

Catálogos vehiculares

Utiliza estos tres endpoints en orden para seleccionar un vehículo:

• Consultar marcas por año
• Consultar modelos por año y marca
• Consultar versiones por año, marca y modelo.

Consultar marcas por año

Información de la solicitud

Método HTTP	URL	Ejemplo
GET	{{auto_financing_base_url}}/api/catalogs/years/{{year}}/brands	https://stg-api.creditas.io/mx/b2b/autofin/api/catalogs/years/2020/brands

{{year}}: Año modelo del vehículo.

Estado de respuesta

El servicio responde con 200 OK y el siguiente cuerpo.

Cuerpo de la respuesta

Campo	Tipo	Descripción
[]	Arreglo de objetos	Lista de marcas disponibles para el año indicado.
Object.id	String	Identificador de la marca.
Object.name	String	Nombre comercial de la marca.

Ejemplo con cURL

curl --location --request GET '{{auto_financing_base_url}}/api/catalogs/years/{{year}}/brands' \
--header 'Authorization: Bearer {{access_token}}'

Ejemplo de respuesta

[
    {
        "id": "910",
        "name": "Acura"
    },
    {
        "id": "920",
        "name": "Alfa Romeo"
    },
    {
        "id": "950",
        "name": "Audi"
    },
    {
        "id": "930",
        "name": "Baic"
    }
]

Consultar modelos por año y marca

Información de la solicitud

Método HTTP	URL	Ejemplo
GET	{{auto_financing_base_url}}/api/catalogs/years/{{year}}/brands/{{brandId}}/models	https://stg-api.creditas.io/mx/b2b/autofin/api/catalogs/years/2020/brands/910/models

{{year}}: Año modelo del vehículo.
{{brandId}}: Identificador de la marca devuelto por el endpoint de marcas

Estado de respuesta

El servicio responde con 200 OK y el siguiente cuerpo.

Cuerpo de la respuesta

Campo	Tipo	Descripción
[]	Arreglo de objetos	Lista de modelos disponibles para el año y la marca indicados.
Object.id	String	Identificador del modelo.
Object.name	String	Nombre comercial del modelo.

Ejemplo con cURL

curl --location --request GET '{{auto_financing_base_url}}/api/catalogs/years/{{year}}/brands/{{brandId}}/models' \
--header 'Authorization: Bearer {{access_token}}'

Ejemplo de respuesta

[
    {
        "id": "528",
        "name": "ILX"
    },
    {
        "id": "801",
        "name": "MDX"
    },
    {
        "id": "802",
        "name": "RDX"
    }
]

Consultar versiones por año, marca y modelo

Información de la solicitud

Método HTTP	URL	Ejemplo
GET	{{auto_financing_base_url}}/api/catalogs/years/{{year}}/brands/{{brandId}}/models/{{modelId}}/versions	https://stg-api.creditas.io/mx/b2b/autofin/api/catalogs/years/2020/brands/910/models/528/versions

{{year}}: Año modelo del vehículo.
{{brandId}}: Identificador de la marca devuelto por el endpoint de marcas
{{modelId}}: Identificador del modelo devuelto por el endpoint de modelos

Estado de respuesta

El servicio responde con 200 OK y el siguiente cuerpo.

Cuerpo de la respuesta

Campo	Tipo	Descripción
[]	Arreglo de objetos	Lista de versiones disponibles para el año, la marca y el modelo indicados.
Object.id	String	Identificador de la versión.
Object.name	String	Nombre comercial de la versión.

Ejemplo con cURL

curl --location --request GET '{{auto_financing_base_url}}/api/catalogs/years/{{year}}/brands/{{brandId}}/models/{{modelId}}/versions' \
--header 'Authorization: Bearer {{access_token}}'

Ejemplo de respuesta

[
    {
        "id": "2020910802280",
        "name": "5p Tech L4/2.0/T Aut"
    },
    {
        "id": "2020910802290",
        "name": "5p A Spech L4/2.0/T Aut"
    }
]