Integrate check update
- 23 Oct 2024
- 1 Minute to read
- DarkLight
- PDF
Integrate check update
- Updated on 23 Oct 2024
- 1 Minute to read
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
This feature is available only on iOS and Android devices.
Mobile Authenticator Studio can be configured to check if an update is available when the app is started. The check update feature consists of checking on the server if an update is available. If an update is available, a link to the available update can be opened.
.png?sv=2022-11-02&spr=https&st=2024-11-19T23%3A07%3A14Z&se=2024-11-19T23%3A17%3A14Z&sr=c&sp=r&sig=wCp7Xlzc%2BORibbIK2llrX718AUAD1qqG1mE7THcmdoM%3D "image(155).png")
Check update (overview)
Check update request
The web service used by Mobile Authenticator Studio is configured in the CheckUpdate section of the configuration file:
<CheckUpdatemandatory="false">
<CheckUpdateRequest>
<URL method="POST"value="http://MY_DOMAIN_NAME/MY_WEB_SERVICE">
<PayloadParameter key="serialNumber"value="%_SerialNumber_%" />
<PayloadParameter key="version"value="%_Version_%" />
</URL >
</CheckUpdateRequest>
</CheckUpdate>
The URL can use the HTTP POST or GET methods. For more information about URL customization, refer to the Mobile Authenticator Studio Customization Guide.
Parameter name | Description |
|---|---|
SerialNumber | The authenticator serial number. If more than one instance is activated on the application, it will show the serial number of the first activated instance. If no instance is activated on the application, it is left empty. Format: Alphanumeric string of 10 characters or an empty string |
Version | The version of the Mobile Authenticator Studio app. Format: Alphanumeric string, limited to 9 characters |
Check update response
The response expected by Mobile Authenticator Studio must be formatted as described in the DTD:
<!ELEMENT DP4Mobile>
<!ATTLIST DP4Mobile updateApplication (no|optional|mandatory) #IMPLIED>
Example
<?xml version="1.0"encoding="UTF-8"?>
<DP4Mobile updateApplication="optional" />
Attribute name | Description |
|---|---|
//DP4Mobile/@updateApplication | Indicates whether an application update is available. Possible values are :
|
Update request
The web service used by Mobile Authenticator Studio is configured in the CheckUpdate section of the configuration file. The defined URL is launched outside the application on the correct application (browser, Play store):
<CheckUpdatemandatory="false">
<CheckUpdateRequest>
...
</CheckUpdateRequest>
<UpdateRequest>
<URL method="GET"value="http://MY_DOMAIN_NAME/MY_WEB_SERVICE" />
</UpdateRequest>
</CheckUpdate>
The URL can use the HTTP POST or GET methods. For more information about URL customization, refer to the Mobile Authenticator Studio Customization Guide.
Was this article helpful?