Mobile SDK

iOS or Android

    API Reference - pims.sdk.configuration

    Info: Stellantis Mobile SDK for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is not publicly available for now.
    Available since: v2.0.X
    Component: SDK
    Security: Authentication is not required.
    Operation:
    Input Parameter
    Param name Description Type Unit/Values Example Required
    environnement

    Environnement value.

    String

    - Production

    - Preproduction

    - development
    Preproduction false
    mode

    Mode value.

    String

    - B2C

    - B2B
    B2C false
    monitoring

    Monitoring informations.

    Object

    / /
    monitoring
     .logLevel

    Log level value.

    String

    - none

    - low

    - medium

    - high
    medium false
    monitoring
     .newLogFile

    New log file mode.

    String

    - appLaunch: creates new log file for every app launch

    - day: creates new log file every day

    - duration: creates new log file every newLogTimeDuration
    duration false
    monitoring
     .newLogTimeDuration

    Duration before 2 log file creation. Manadatory only if newLogFile==duration

    Integer

    Between 5 and 1440.

    42 false
    credential

    Credential informations.

    Object

    / /
    credential
     .clientId

    Client ID CVS Server.

    String

    n/a

    6779ef20e75817b79602 false
    credential
     .clientSecret

    Client Secret CVS Server.

    String

    n/a

    865333ef347etr false
    credential
     .macID

    MAC id value of inwebo SDK.

    String

    n/a

    false
    credential
     .inWeboURL

    Server url of inwebo SDK.

    String

    n/a

    https://address.tld false
    credential
     .webviewsRedirectURI

    Webviews redirecURI.

    String

    n/a

    https://address.tld false
    credential
     .loginRedirectURI

    Login redirect URI.

    String

    n/a

    https://address.tld false
    profile

    Profile informations.

    Object

    / /
    profile
     .brand

    Brand value.

    String

    - Peugeot

    - Citroen

    - Ds

    - Opel

    - Vauxhall
    opel false
    Output Data
    No data
    Error
    Error Code Error Label
    2001

    Facade not initialized

    Code Example
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    
    pims.set("pims.sdk.configuration",
      mapOf( /* parameters */  
        Pair("environnement", "Production"),
        Pair("mode", "B2C"),
        Pair("monitoring", map0f(
          Pair("logLevel", "low"),
          Pair("newLogFile", "appLaunch"),
          Pair("newLogTimeDuration", 42)
        )
        Pair("credential", map0f(
          Pair("clientId", "6779ef20e75817b79602"),
          Pair("clientSecret", "865333ef347etr"),
          Pair("macID", "<macIDValue"),
          Pair("inWeboURL", "https://address.tld"),
          Pair("webviewsRedirectURI", "https://address.tld"),
          Pair("loginRedirectURI", "https://address.tld")
        )
        Pair("profile", map0f(
          Pair("brand", "opel")
        ) 
      ) 
    ) { message -> when (message["status"] as? String) {
          "SUCCEEDED" -> { }                          // handle succeeded status
          "FAILED" ->    { }                          // handle failed status
      } }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    
    pims.set(api: "pims.sdk.configuration",
      parameters: [  
      "environnement": "Production",
        "mode": "B2C",
        "monitoring": [
          "logLevel": "low",
          "newLogFile": "appLaunch",
          "newLogTimeDuration": 42
        ]
        "credential": [
          "clientId": "6779ef20e75817b79602",
          "clientSecret": "865333ef347etr",
          "macID": "macIDValue",
          "inWeboURL": "https://address.tld",
          "webviewsRedirectURI": "https://address.tld",
          "loginRedirectURI": "https://address.tld
        ]
        "profile": [
          "brand": "opel"
        ] ]
      ) { (message) in 
        if message["status"] == "SUCEEDED"    { }    // handle succeeded status
        else if message["status"] == "FAILED" { }    // handle failed status
      } 
    
    1
    2
    3
    4
    5
    6
    
    // representation of the `succeeded` dictionary object message as JSON
    {
      "transactionId": "953cfefb-bc72",
      "status": "SUCCEEDED",
      "result": null
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    
    // representation of the `failed` dictionary objects messages as JSON
    
    /* -------- STATUS FAILED: 2001 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2001,
        "label": "Facade not initialized"
      }
    }