Skip to content

Get a catalog

OpenAPI specifications

get https://api.autopass.pro/v1/catalog

This API relies on an expert system of different algorithms to provide the right OE reference. This allows on one hand to cover different vehicle markets; on the other hand, it improves our catalog knowledge.

Query parameters

reg_or_vin
  • Type: string

This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.

vin
  • Type: string

This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.

reg_plate
  • Type: string

This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.

reg_country
  • Type: string

This parameter specifies the country where the car has been registered. This could be different from the country from which the request is made. For instance when repairing a car registered in Italy in a workshop in France. This is an ISO 3166-1 alpha-2 code. If not specified, the value used is the same as the parameter country.

country
  • Type: string
  • Default: FR

This parameter specifies the country in which the response is calculated. This influence some AM references selection and more generally triggers country specific offers in terms of brands. country must be ISO 3166-1 alpha-2. Note that this is not the language but the country.

company
  • Type: string

User company. Could be used to specify the company or one of its department calling the API. This is typically the highest level of the hierarchy. This parameter is returned but has no influence on the result.

entity
  • Type: string

User entity. Could be used to identify a specific workshop or an agent calling the API. This is usually the lowest level in the hierarchy. Using it is recommended to identify uniquely the caller. This parameter is returned but has no influence on the result.

activities
  • Type: string

User activities. Could be used in a transversal way to identify qualities / specific characteristics of the caller. For instance the type of activities covered by the workshop. This parameter is returned but has no influence on the result.

plan
  • Type: string

Possible plans: * **pro** basic response where we focus on lowest response time (approximately 0.8s).

product_category
  • Type: integer

Product category ID that group a list of families to focus/Filters on (This parameter could be customized by user).

product_family
  • Type: integer

Family ID to focus/Filters on.

Responses

200 - OK.

401 - Unauthorized.

403 - Forbidden.

422 - Unprocessable content.