Webportal v2

embedded apps

    Quickstart - API Response

    HOW TO GET WEBPORTAL RESPONSE #

    ONMESSAGE #

    Onmessage is a browser API that you need to work with using Stellantis Embedded Webportal for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall).

    As your App is a dedicated Window object, postMessage is a way to receive message from Webportal. Doing so, you’re app is able to receive info that you request with postMessage

    Here is a typical that you need to send to webportal in order to communicate with the vehicle:

    1
    2
    3
    4
    5
    
    // Response
    this.onmessage(function(e) {
    	var idpResponse = e.data;
    	console.log(idpResponse);
    })
    

    MESSAGE FORMAT #

    1
    2
    3
    4
    5
    6
    7
    8
    
    {
      "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
      "type": "REPLY",
      "api": "configuration.VIN",
      "status": 200,
      "statusText": "OK",
      "data": "VF7NCRHE8AY539138"
    }
    
    Name Value Type Value Description
    id string n/a This is the uniq Id of your request you have set when you send the request, this way you are be able to identify response this particular request.
    type Enum of strings ['GET', 'SET', 'SUBSCRIBE'] Type of reponse.
    api string n/a Name of the API. Find a list here
    status int [200, 400] This code inform you if the status of your request is ok 200 or not 400.
    statusText string n/a This is a message comming with status code.
    data string or object n/a This field is where you will receive the data of your request.