WEB API

accessing party for end-users

Quickstart - Access End-User Data

Edit
Info: Stellantis Accessing Party for End-Users API for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is available only on request.

Requirement:

Tutorial Output: an authorized access to the Accessing Party for End-Users API.

  • 🚗 An authorized access to the vehicle data of the End User.

In this page, we will build a valid HTTP request to the Accessing Party for End-Users API. First, make sure you have completed the following tutorials: Authentication summary, App registration, Enroll Users.

As an Accessing Party, you’ll need the following credentials to End-Users APIs:

  • 👤 Application Client ID.
  • 🗝 Application Client Secret.
  • 📄 Application Issued Certificate.
  • 📜 Stellantis CA Certificate.
  • 🔑 Application Private key
  • 🪙 An Access Token for each of your customers.

Manufacturers Brands & Realms #

In this tutorial API calls require the manufacturer {brand.tld} or <realm>. They both depends on the vehicle brand and should be retrieved on your side based on the vehicle VIN. Available realms are:

| Manufacturer Brand | {brand.tld} | <realm> | |–|–|–| | Peugeot | peugeot.com | clientsB2CPeugot/OTPPeugeot | | Citroën | citroen.com | clientsB2CCitroen/OTPCitroen | | DS | driveds.com | clientsB2CDS/OTPDS | | Opel | opel.com | clientsB2COpel/OTPOpel | | Vauxhall | vauxhall.co.uk | clientsB2CVauxhall/OTPVauxhall |

Request Example #

Requesting the following API will respond data about the End-User account. The following data are required in the request:

Type Name Value Description Required
Query Parameter client_id <client_id> Client Id of your application. Yes
Header x-introspect-realm <realm> Vehicle manufacturer realm. Yes
Header Authorization: Bearer <access-token> Ressource Owner Access Token. Yes
File Client Certificate path/to/client_certificate.pem Your SSL certificate for authentication in Stelantis network. Yes
File Private Key path/to/key.pem Your Private Key file. Yes
File CA Certificate path/to/ca_certificate.pem Stellantis CA Cert for peer verification. Yes
GET | https://api-cert.groupe-psa.com/connectedcar/v4
/user 
1
2
3
4
5
6
7
8
9

$ curl \
  --request GET \
  --url 'https://api-cert.groupe-psa.com/connectedcar/v4/user' \
  --data-urlencode 'client_id=<client_id>' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'x-introspect-realm: <realm>' \
  --key 'path/to/key.pem' \
  --cert 'path/to/client_cert.pem[:<cert_password>]' \
  --cacert 'path/to/ca_cert.pem' \

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

HTTP/1.1 200 OK
Date: Day, XX Mon YYYY HH:MM:SS GMT
Content-Type: application/json

{
  /*Timestamps*/
  "updatedAt": "YYYY-MM-24THH:MM:SSZ",
  "createdAt": "YYYY-MM-24THH:MM:SSZ",
  /*Related Resources*/
  "_links": { },
  /*Account Info*/
  "email": "user@emailprovider.com",
  "firstName": "string",
  "lastName": "string",
  /*Embedded Resources*/
  "_embedded": { "Vehicles": [] }
}

These data are information about the user related to the access token of the HTTP request.

You might need to check out the API Concepts in order to understand this API structure like:

  • Single object vs. Collections
  • collection Pagination
  • discovering resources using _links

API References

You just perform your first HTTP request to the End-User API! You can browse this page for more request examples.