Home B2Core API REST API The Front Office API The mobile app settings

The mobile app settings

Use this method to get settings related to the mobile app that clients can download to their iOS and Android devices.

GET[host]/api/v2/my/settings/mobile

You can display to your clients QR codes for signing in to the B2Core UI using the mobile app, as well as QR codes for downloading the mobile app to their iOS and Android devices.

Use this method to get settings specified for these QR codes.

Request

Header parameters:

Authorization: Bearer <access_token>

GET[host]/api/v2/my/settings/mobile

curl --location --request GET 'https://host.name/api/v2/my/settings/mobile' \
--header 'Authorization: Bearer <token>'

Response

A response includes the following data:

qrCodeLifetime integer

The number of minutes a QR code for signing in to the B2Core UI is valid. The default value is 2.

You can display to your clients QR codes for signing in to the B2Core UI. Instead of entering credentials, clients can scan such QR codes with their phones and sign in to the B2Core UI using the mobile app to which they have already been signed in.

applications array

An array of objects specifying URLs for downloading the mobile app.

You can display to your clients QR codes that they can scan to quickly download the mobile app to their iOS and Android devices.

Show object fields

type string

The mobile app platform. Possible values:

iOS
Android

url string or null

A URL for downloading the mobile app.

    RESPONSE EXAMPLE
  
{
    "qrCodeLifetime": 2,
    "applications": [
      {
        "type": "iOS",
        "url": "A URL to download the mobile app for iOS"
      },
      {
        "type": "Android",
        "url": "A URL to download the mobile app for Android"
      }
    ]
  }

The mobile app settings

Get the mobile app settings