Quickstart - Examples

Edit

Info: Stellantis Fleet Owner API for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is made for organisations owning fleet of vehicles.

This page is a list of examples of HTTP requests to Stellantis Fleet Owners API.

These examples will show you how to deal with:

Single objects
Collections objects, and pagination
GeoJSON
Post and Delete verbs HTTP verbs

Check out the following pages to learn about the concepts of single objects, collection and paginations in this API.

Get Account Info #

Web API base endpoint /fleets allows retrieving information about this account Fleet(s) of vehicles..

This endpoint returns a single object.

GET | https://api-cert.groupe-psa.com/connectedcar/v3
/fleets

        
            HTTP Request
          
$ curl \
  --request GET \
  --url 'https://api-cert.groupe-psa.com/connectedcar/v3/fleets' \
  --data-urlencode 'client_id=<client_id>' \
  --header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
  --key 'path/to/key.pem' \
  --cert 'path/to/client_cert.pem[:<cert_password>]' \
  --cacert 'path/to/ca_cert.pem' \

Get a List of Vehicles #

The /fleets/{fid}/vehicles endpoint allows you to retrieve a list of your vehicles.

This endpoint returns a collection, checkout pagination for more information about indexRange and pageSize.

GET | https://api-cert.groupe-psa.com/connectedcar/v3
/fleets/{fid}/vehicles

        
            HTTP Request
          
$ curl \
  --request GET \
  --url 'https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/vehicles' \
  --data-urlencode 'client_id=<client_id>' \
  --header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
  --key 'path/to/key.pem' \
  --cert 'path/to/client_cert.pem[:<cert_password>]' \
  --cacert 'path/to/ca_cert.pem' \
  --data-urlencode 'indexRange=<element_per_page>' \
  --data-urlencode 'pageSize=<nb_of_pages>' \

Get Alerts of a Vehicle #

The /fleets/{fid}/vehicles/{id}/alerts endpoint allows to retrieve a list of alerts for a vehicle.

Path parameter {id} is the unique identifier of a vehicle.
Query parameter locale will change the language of the alert message.

GET | https://api-cert.groupe-psa.com/connectedcar/v3
/fleets/{fid}/vehicles/{id}/alerts

        
            HTTP Request
          
$ curl \
  --request GET \
  --url 'https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/vehicles/{id}/alerts' \
  --data-urlencode 'client_id=<client_id>' \
  --header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
  --key 'path/to/key.pem' \
  --cert 'path/to/client_cert.pem[:<cert_password>]' \
  --cacert 'path/to/ca_cert.pem' \
  --data-urlencode 'indexRange=<element_per_page>' \
  --data-urlencode 'pageSize=<nb_of_pages>' \
  --data-urlencode 'locale=<language>' \

Post New Monitor #

The /fleets/{fid}/monitors endpoint allows you to create a new monitor.

Checkout the dedicated tutorial for information about Monitors.

        
            
              
            
            HTTP Request
          

            
              
            
            HTTP Body
          

      
$ curl \
  --request POST \
  --url 'https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/monitors' \
  --data-urlencode 'client_id=<client_id>' \
  --header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
  --key 'path/to/key.pem' \
  --cert 'path/to/client_cert.pem[:<cert_password>]' \
  --cacert 'path/to/ca_cert.pem' \
  --data '<check out HTTP body>' \
{
   "label":"IDF Zone monitor With Data Triggering:[vehicle.energy.electric.level] OR on Mondays",
   "subscribeParam":{
      "refreshEvent":600,
      "retryPolicy":{
         "policy":"Always",
         "maxRetryNumber":3,
         "retryDelay":120
      },
      "batchNotify":{
         "size":10,
         "timeWindow":300
      },
      "callback":{
         "target":"http://my.dn/monitors/cb1",
         "name":"HTTP_CB",
         "attributes":[
            {
               "type":"Query",
               "key":"vin",
               "value":"$vin"
            },
            {
               "type":"Header",
               "key":"Authorization",
               "value":"Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="
            }
         ]
      }
   },
   "extendedEventParam":[
      "vehicle.alerts",
      "vehicle.status"
   ],
   "triggerParam":{
      "triggers": [
      {
         "name": "outOfParis",
         "zone": {
            "transition": "Out",
            "circle": {
               "radius": 20,
               "center": {
               "longitude": 2.333333,
               "latitude": 48.866667
               }
            }
         },
         "name": "onMonday",
         "time": {
            "times": [
               {
               "recurrence": "Daily",
               "start": "PT14H30M",
               "occurence": {
                  "day": [
                     "Mon"
                  ]
               },
               "duration": "PT04H30M"
             }
            ],
            "time.zone": "Europe/Paris"
         },
         "name": "batteryIsLow",
         "data": {
          "data": "vehicle.energy.electric.level",
          "op": "lowerThan",
          "value": [
            "50"
            ]
        }
      }
    ],
    "bool.exp": "((outOfParis & (batteryIsLow | onMonday)"
  }
}

Delete a Monitor #

The /fleets/{fid}/monitors/{mid} endpoint allows you to retrieve a list of alerts for a vehicle.

Checkout the dedicated tutorial for information about Monitors

DELETE | https://api-cert.groupe-psa.com/connectedcar/v3
/fleets/{fid}/monitors/{mid}

        
            HTTP Request
          
$ curl \
  --request DELETE \
  --url 'https://api-cert.groupe-psa.com/connectedcar/v3/fleets/{fid}/monitors/{mid}' \
  --data-urlencode 'client_id=<client_id>' \
  --header 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
  --key 'path/to/key.pem' \
  --cert 'path/to/client_cert.pem[:<cert_password>]' \
  --cacert 'path/to/ca_cert.pem' \

References

Check out this API references to discover Stellantis Connected Vehicles features.

WEB API

for fleet owner