Skin

Objects

Skin object

Attribute Description
skinId Unique identifier of the skin.
e.g. C7EC6C62-72EC-46F4-BD9D-CD051E48AE44
skinName Name of the skin.
e.g. Default skin
skinType Type of the skin. Possible values are
- DEFAULT
- BEACON
- GEOFENCING
skinStateCd Status of skin. Possible values are
- ACTIVE
- INACTIVE
containers JSON format SKIN definition for client’s look and feel
lastModifiedDtim Date and time of the skin data last updated.
Format is yyyy-MM-dd’T’HH:mm:ss.SZ
e.g. “2019-02-08T14:23:35.443-0500”
yyyy: Year, e.g. 1996 <br>MM: Month in year, e.g. 07
dd: day in month, e.g. 10
HH:hour in day(0-23), e.g.0
mm:Minute in hour, e.g. 30
ss: Second in minute, e.g. 50
S: Millisecond in the minute, e.g. 443
Z: Timezone offset in hours(RFC 822 pattern), e.g. -0800
beconIds List of beacon IDs when skinType is BEACON

APIs

Retrieve skin definition

Supply the skin id obtained in the previous request and retrieve its JSON format skin definition

Precondition

None

Request

HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/skin/{version}/getSkin

Body parameters

Parameters Type Required Note
walletId String Required Your tenant name e.g. JANUS
skinId String Required Unique identifier of the skin e.g. C7EC6C62-72EC-46F4-BD9D-CD051E48AE44

Example request

curl -X POST "http://api-dev.fintiv.co:8080/skin/v2/getSkin"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"skinId":"00D3E1B8-177B-451B-8D53-5DB584422A56","walletId":"JANUS"}’

Response

Returns skin object
Example response

{
  "result": {
    "code": 0
  },
  "skinId": "00D3E1B8-177B-451B-8D53-5DB584422A56",
  "walletId": "JANUS",
  "skinName": "iOS Beacon 1",
  "skinType": "BEACON",
  "skinStateCd": "ACTIVE",
  "containers": {
    "common": [
      {
        "propertyName": "backgroundColor",
        "propertyType": 0,
        "propertyValue": "#DDDDDD",
        "description": "Background color for each screen"
      },
      {
        "propertyName": "primaryTextColor",
        "propertyType": 0,
        "propertyValue": "#404040",
        "description": "Main theme color for buttons/icons etc."
      },
      {
        "propertyName": "secondaryTextColor",
        "propertyType": 0,
        "propertyValue": "#BFBFBF",
        "description": "Currently not used in Android"
      },
      {
        "propertyName": "activeButtonTextColor",
        "propertyType": 0,
        "propertyValue": "#5393F0",
        "description": "Text color for all the flat buttons in active state"
      },
      {
        "propertyName": "inactiveButtonTextColor",
        "propertyType": 0,
        "propertyValue": "#CCCCCC",
        "description": "Text color for flat button in inactive state"
      },
      {
        "propertyName": "image",
        "propertyType": 1,
        "propertyValue": "https://www.chiquipedia.com/imagenes/El-sapo-ladron.jpg",
        "description": "Logo image"
      },
      {
        "propertyName": "image02",
        "propertyType": 1,
        "propertyValue": "https://www.chiquipedia.com/imagenes/El-sapo-ladron.jpg",
        "description": "Logo image 2"
      }
    ],
    "navigationBar": [
      {
        "propertyName": "navigationBarColor",
        "propertyType": 0,
        "propertyValue": "#F4B76B",
        "description": "Not used in Android"
      },
      {
        "propertyName": "tintColor",
        "propertyType": 0,
        "propertyValue": "#F93C1B",
        "description": "Not used in Android"
      },
      {
        "propertyName": "backgroundColor",
        "propertyType": 0,
        "propertyValue": "#1C293C",
        "description": "Background color of title bar"
      },
      {
        "propertyName": "textColor",
        "propertyType": 0,
        "propertyValue": "#FFFFFF",
        "description": "Text and icon color in title bar"
      }
    ],
    "navigationBar_title": [
      {
        "propertyName": "textColor",
        "propertyType": 0,
        "propertyValue": "#F93C1B",
        "description": "iOS specific property"
      }
    ],
    "navigationBar_backItem": [
      {
        "propertyName": "tintColor",
        "propertyType": 0,
        "propertyValue": "#F93C1B",
        "description": "iOS specific property"
      }
    ],
    "screenSignIn": [
      {
        "propertyName": "tint",
        "propertyType": 0,
        "propertyValue": "#74823894",
        "description": "iOS specific property"
      },
      {
        "propertyName": "borderColor",
        "propertyType": 0,
        "propertyValue": "#DE441C",
        "description": "iOS specific property"
      },
      {
        "propertyName": "background",
        "propertyType": 0,
        "propertyValue": "#F4B76B",
        "description": "iOS specific property"
      }
    ],
    "screenVerifyPin": [
      {
        "propertyName": "tint",
        "propertyType": 0,
        "propertyValue": "#74823894",
        "description": "description of the property"
      },
      {
        "propertyName": "borderColor",
        "propertyType": 0,
        "propertyValue": "#DE441C",
        "description": "iOS specific property"
      },
      {
        "propertyName": "background",
        "propertyType": 0,
        "propertyValue": "#F4B76B",
        "description": "iOS specific property"
      }
    ]
  }
}

Retrieve list of skins to be monitored

Client retrieves list of skins configured in the backend. Only active skins are returned. If any skin cached in the client is not returned, client should delete and not use it.

Precondition

None

Request

HTTP Method / URL
POST / http://api-dev.fintiv.co:8080/skin/{version}/getMySkinService

Body parameters

Parameters Type Required Note
walletId String Required Your tenant name e.g. JANUS
bundleId String Optional Identifier to detect default skin for the client. It could be bundleId in IOS, package name in Android, or any unique value predefined in the portal. e.g. com.corfire.white.wallet

Example request

curl -X POST "http://api-dev.fintiv.co:8080/skin/v2/getMySkinService"
-H "accept: application/json;charset=UTF-8"
-H "api-key: <insert your APP Key here>"
-H "authorization: Bearer <insert your bearer token here>"
-H "Content-Type: application/json"
-d ‘{"bundleId":"com.corfire.white.wallet","walletId":"JANUS"}’

Response

Returns list of skins with their type and last modified timestamp information.
Example response

{
  "result": {
    "code": 0
  },
  "skinList": [
    {
      "skinId": "2B62F622-C2C1-441B-B746-FB1136C9F261",
      "skinType": "DEFAULT",
      "lastModifiedDtim": "2018-11-14T01:07:38+0000"
    },
    {
      "skinId": "F6EF56A4-418C-4451-AC66-6D155A772EA1",
      "skinType": "BEACON",
      "lastModifiedDtim": "2018-11-14T02:26:42+0000",
      "beaconIds": [
        "32523534634634636"
      ]
    },
    {
      "skinId": "00D3E1B8-177B-451B-8D53-5DB584422A56",
      "skinType": "BEACON",
      "lastModifiedDtim": "2018-11-14T02:30:24+0000",
      "beaconIds": [
        "123456789087483829"
      ]
    }
  ]
}