With one click on a link can start your inspection
The “Cargosnap inspection link” makes it really easy to ask someone in your team or organization to perform a specific inspection by crafting a URL (link) that pre-defines the specific workflow to use, as well as the reference to store the inspection under.
It allows starting the app in a state where a specific top-widget (reference) is shown (with an optional prefilled reference) and an optional bottom-widget (workflow).
How to create your Inspection link (URL)
In order to use the link, all you need to do is present a Cargosnap mobile app user with a link (URL). We often see that this link is provided as a QR code.
The Cargosnap Inspection link (URL)
https://open.cargosnap.com/?reference=[A]&top=[B]&bottom=workflows&workflow_id=[D]
Parameters in the Inspection link (URL)
Where you need to replace the square bracket placeholders with values for the corresponding component:
- [A]: reference (optional): the code to pre-fill the top widget value with
-
[B]: top (required): Reference to a top-widget. Possible values:
- keyboard
- barcode
- number
- container
- license_eu
- license_br
-
timestamp
-
[C]: bottom (required): Reference to a bottom-widget. Possible values:
-
- workflows
- forms
- snap
- serial snapper
-
[D]: Workflow ID (required if workflow): Refers to the specific workflow.
- The workflow ID ([D]) can be found by selecting the specific workflow. Navigate in the topbar to 'Workflows' and click the workflow you'd like to select. Now take the reference ID from the URL:
Now replace A/B/C/D with the right parameters. For example:
[A] 123 (Reference)
[B] barcode (Top widget)
[C] workflows (Bottom widget)
[D] 12345 (Workflow ID)
Then your URL eventually looks like this:
https://open.cargosnap.com/?reference=123&top=barcode&bottom=workflows&workflow_id=12345
Include the team/location scope
As your device may be registered under multiple accounts, it is a good practice to include the specific teams scope the device works under. That can be done by including the query parameter "team_id" ([E]), like for example: &team_id=1
The number to use corresponds to the number that's shown in the URL, at the end, when you click the location in the overview:
This thus would resolve in the following link:
Closing the mobile app (only for Android):
If you want Cargosnap to close after completing the workflow (so the app calling Cargosnap can take over again), include another parameter: minimizeonfinish=true. Note this feature is only available on Android devices (on iOS, users need to terminate/switch manually).
Demo video:
In below demo video you can see that we linked the URL to an Image. So by clicking the image, you will start the inspection.
Developer
Developers, build in this deeplink into your own code! Read up in the Cargosnap developers documentation how to do so.