2.6. Universal Link

OPSWAT Mobile App now supports universal link to provide a seamless way for you to link a custom id in your solution with a device id OPSWAT Mobile App generates for a device. By this way, your solution can use the custom id to query device details on MetaAccess. Your app/website just needs to provide an OPSWAT Mobile App's universal link with a custom id as a parameter to end-users. By tapping the link, the universal link lets the user open the installed OPSWAT Mobile App and pass the custom id to the app. The OPSWAT Mobile App reports compliance data and links the custom id with the device id. Your solution can then use the Device Details API to query the device details with the custom id.

Universal Link Format

https://mobile.metaaccess.opswat.com/<custom_id>?app_name=<APP_NAME>&app_id=<APP_ID>

Schema Link Format (Only available on Android app)

metaaccess://<custom_id>?app_name=<APP_NAME>&app_id=<APP_ID>

Parameters

Parameter

Data Type

Description

Required

custom_id

string

a unique custom id you want to link to the device. If it's invalid, OPSWAT Mobile App fails to send a report to the MetaAccess and shows the error code as 4000

Only accept a-z, A-Z, 0-9, and hyphen (-) characters. Maximum length is 50 characters

Yes

app_name

string

name of an app which you want to tell the user go back after opening OPSWAT Mobile App. After reporting compliance data to MetaAccess successfully, OPSWAT Mobile App will show a message to tell the user to go back to that app. If this is invalid or missing, OPSWAT Mobile App just tells users go back to previous app

Optional

app_id

string

Android package name/iOS app scheme of the app which you want the user goes back. If this is invalid or missing, users need to go back to the desired app manually. Note that app_id is case-sensitive

See How could I find an app ID of an application?

Optional

Common Error Codes

The OPSWAT Mobile App will throw error message to end-users along with a specific error code.

Error code

Error Description

Resolution

4000

The custom id in the universal link is invalid

 

(No specific error code)

The MetaAccess app could not connect to the MetaAccess server

  1. If a device is on a cellular network, please check if the MetaAccess app is allowed to use cellular data

  2. Check if a mobile device can connect to the MetaAccess servers which the app is connecting to.

  3. If the server is up.

Example with an appID:

iOS: https://mobile.metaaccess.opswat.com/TEST67AD71?app_name=Salesforce&app_id=salesforce1://
Android: https://mobile.metaaccess.opswat.com/TEST67AD71?app_name=Salesforce&app_id=com.salesforce.chatter

On the OPSWAT Mobile App, users will get a message like the one below after the app reports data to the MetaAccess successfully.

images/download/attachments/334927/Report_successfully.png

Example with an invalid custom id:

iOS: https://mobile.metaaccess.opswat.com/TEST!?app_name=Salesforce&app_id=salesforce1://

On OPSWAT Mobile App, users will get the below error message.

images/download/attachments/334927/report_failed.png

Browser Support Chart

(Tested on iPhone 7, Samsung, Nexus)

 

iOS

Android

Normal mode

Private mode

Normal mode

Private mode

Safari

Universal Link

Universal Link

 

 

Edge

Universal Link

Universal Link

Universal Link

Schema

 

Chrome

Universal Link

 

Universal Link

Schema

Schema

Firefox

Universal Link

Universal Link

Schema

 

Opera

Universal Link

Universal Link

Schema

 

Samsung browser

 

 

Universal Link

Schema

 

As June 15, 2018, MetaAccess releases a new agent version on mobile devices which supports Universal Link

  • iOS app version: 2.45.11+

  • Anroid app version: 2.54.4+