API V3
======

The GroupVAN API V3 provides catalog and vehicle services with an improved
query-parameter interface for building automotive aftermarket applications.

Base URL
--------

.. list-table::
   :header-rows: 1
   :widths: 30 70

   * - Environment
     - URL
   * - Production
     - ``https://api.groupvan.com``
   * - Staging
     - ``https://api.staging.groupvan.com``

Authentication
--------------

All V3 endpoints require a valid JWT Bearer token in the request header.
See :doc:`authentication` for details on generating a self-signed JWT.

.. code-block:: none

    Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Available Services
------------------

**Catalogs**

.. list-table::
   :header-rows: 1
   :widths: 25 10 40 25

   * - Service
     - Method
     - Endpoint
     - Description
   * - :doc:`List <catalogs/list>`
     - GET
     - ``/v3/catalogs/list``
     - Query available catalogs
   * - :doc:`Vehicle Categories <catalogs/vehicle_categories>`
     - GET
     - ``/v3/catalogs/{id}/vehicle/{index}/categories``
     - Retrieve categories for a vehicle
   * - :doc:`Supply Categories <catalogs/supply_categories>`
     - GET
     - ``/v3/catalogs/{id}/categories``
     - Retrieve supply categories
   * - :doc:`Application Assets <catalogs/application_assets>`
     - GET
     - ``/v3/catalogs/application_assets``
     - Retrieve application media assets
   * - :doc:`Cart <catalogs/cart>`
     - GET
     - ``/v3/catalogs/cart/{cart_id}``
     - Retrieve cart contents
   * - :doc:`Product Info <catalogs/product_info>`
     - GET
     - ``/v3/catalogs/product/info``
     - Retrieve product information

**Vehicles**

.. list-table::
   :header-rows: 1
   :widths: 25 10 40 25

   * - Service
     - Method
     - Endpoint
     - Description
   * - :doc:`Plate <vehicles/plate>`
     - GET
     - ``/v3/vehicles/plate``
     - Look up vehicle by license plate
   * - :doc:`VIN <vehicles/vin>`
     - GET
     - ``/v3/vehicles/vin``
     - Look up vehicle by VIN
   * - :doc:`User <vehicles/user>`
     - GET
     - ``/v3/vehicles/user``
     - Query user's recent vehicles
   * - :doc:`Fleets <vehicles/fleets>`
     - GET
     - ``/v3/vehicles/fleets``
     - Query user's fleets
   * - :doc:`Account <vehicles/account>`
     - GET
     - ``/v3/vehicles/account``
     - Query account vehicles
   * - :doc:`Groups <vehicles/groups>`
     - GET
     - ``/v3/vehicles/groups``
     - Query vehicle groups
   * - :doc:`Filter <vehicles/filter>`
     - GET
     - ``/v3/vehicles/filter``
     - Filter vehicles by criteria
   * - :doc:`Engines <vehicles/engines>`
     - GET
     - ``/v3/vehicles/engines``
     - Query engine configurations
   * - :doc:`Search <vehicles/search>`
     - GET
     - ``/v3/vehicles/search``
     - Search for vehicles

.. toctree::
   :maxdepth: 2
   :hidden:

   authentication
   catalogs/index
   vehicles/index
   reference