Configuration link#
A configuration link lets a user set up the FileCap app with one tap instead of typing a server address and API key. The link carries the portal host, the API key, the sender’s email address and optionally the mobile number. The app applies the settings, verifies them with the server, shows the result and returns to the Send screen. If verification fails, the previous settings are restored.
The same link format is used by the iOS app and the upcoming Android app.
Link format#
filecap://configure?host=company.filecap.eu&apikey=0123456789ABCDEF0123456789ABCD&email=j.doe%40company.com&phone=0612345678An https form exists as well, for email clients that strip custom URL schemes:
https://company.filecap.eu/FileCap/app/configure?apikey=0123456789ABCDEF0123456789ABCD&email=j.doe%40company.com&phone=0612345678Here the portal host is taken from the URL itself. This form opens the app directly once the portal serves the Apple apple-app-site-association file; until then the filecap:// form is the one to use.
Parameters#
| Parameter | Required | Also accepted |
|---|---|---|
host | yes (filecap:// form) | hostname, portal, portalurl, server. A full URL such as https://company.filecap.eu/FileCap is reduced to the host name |
apikey | yes | key |
email | yes, must contain @ | mail, senderemail, user, useremail |
phone | no | mobile, mobilenumber, sendermobilenumber |
Parameter names are case-insensitive. Values must be URL-encoded (@ becomes %40). Empty values count as absent, unknown parameters are ignored, and a link that misses a required parameter is rejected entirely: the app never applies a partial configuration.
Sending the link#
Build the link with the portal’s API key (admin panel: Configuration > Add-ins and apps > API Key, see Add-ins and apps) and the user’s email address, and send it by email from a trusted sender. A short instruction such as “Open this email on your iPhone and tap the link” is enough.
If the device is also managed through MDM, the link can only fill in the values the MDM did not deliver; locked values are left untouched.
Device registration link#
When API registration required is enabled on the portal, the server emails each user a registration code (see Device registration). Besides pasting the code in the app, the user can tap a link in that email:
filecap://register?code=DVCFBZaUKNQjA9gbhMfYdu0oOnVYGxZ0V&email=j.doe%40company.com| Parameter | Required | Also accepted |
|---|---|---|
code | yes | registrationcode, key, deviceapikey, token |
email | no, but recommended | mail, emailaddress, senderemail |
When email is present, the app checks that it matches the configured sender address and explains a mismatch. It then exchanges the code for the device key and shows This device is registered. Keep the plain code in the email as well, for users who prefer to paste it and for mail clients that strip custom URL schemes.
Security notes#
- The link contains the portal’s API key, which allows sending through the portal. Treat the email like a credential: send it only to the intended user and ask users not to forward it.
- The app never applies a link silently: the result screen always shows which server and address were configured.
- Should the key leak, regenerate it in the admin panel; old links and every add-in or app using the old key then stop working until reconfigured.