From 7cf4013d58fe4723773d74fbaf3325005bddff35 Mon Sep 17 00:00:00 2001 From: rishoej Date: Thu, 30 Jun 2022 09:55:39 +0200 Subject: [PATCH 1/2] Add deep link section --- README.md | 6 ++++++ deep-links.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 deep-links.md diff --git a/README.md b/README.md index f4ce6cb..d24ca97 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,12 @@ The "Frontend API" for the Workshop product. Explains how to prefill forms, pre- [Read more here](./workshop.md) +### Deep links + +Deep links allows to redirect a user from an email, sms or in-app notification directly to a specific page in the app. + +[Read more here](./deep-links.md) + ### FTPS/SFTP Legacy integration can be done with FTPS and SFTP but we try to avoid it. diff --git a/deep-links.md b/deep-links.md new file mode 100644 index 0000000..91c9f08 --- /dev/null +++ b/deep-links.md @@ -0,0 +1,56 @@ +# Deep links documentation + +Deep links allows to redirect a user from an email, sms or in-app notification directly to a specific page in the app. + +A deep link consists of the "app domain" which tells you what app to open and the actual deep link pointing to the page in the app you want to open. + +Combine the two into one link and you get a better user friendly experience. + +## App domains + +| Apps | Domains | +|:-----|:--------| +| MinVolkswagen | https://app.minvolkswagen.dk | +| MinSKODA | https://app.minskoda.dk | +| MinSEAT | https://app.minseat.dk | +| mitAudi | https://app.mitaudi.dk | +| Connected Cars (use as default) | https://app.connectedcars.io | +| Connected Cars Fleet | https://fleetapp.connectedcars.io | +| FleetConnect | https://fleetapp.fleetconnect.se | +| MinVolkswagenFleet | https://fleetapp.minvolkswagenfleet.dk | +| The Originals | https://app.theoriginals.es | +| Staging | https://app.staging.connectedcars.io | + +## Deep links + +| App page | Link | +|:---------|:-----| +| Default front page | /dashboard/ | +| Front page per vehicle | /dashboard/[vehicleID] | +| Booking page per vehicle | /dashboard/booking/[vehicleID] | +| Message page per vehicle | /messages/[vehicleID] | +| Trips page per vehicle | /trips/[vehicleID] | +| Workshop page per vehicle | /workshop/[vehicleID] | +| Lookup vehicle | /lookup/[licensePlate] | +| More | /more | +| Profile settings | /more/profile | +| Notification settings | /more/profile/notifications | +| Partnerships | /more/partnerships | +| Support | /more/support | +| Roadside assistance | /more/roadside | +| Insurance card (won't work w/o vehicle ID) | /more/insurance/[vehicleID] | +| Leasing card (won't work w/o vehicle ID) | /more/leasing/[vehicleID] | +| Audi - Video channel | /videoChannel | +| Audi - MyGarage | /myGarage | + +## Example + +Each deep link would look like this for MinVolkswagen: + +- https://app.minvolkswagen.dk/dashboard/[vehicleID] + +or + +- https://app.minvolkswagen.dk/booking/[vehicleID] + +For all of the ones including [vehicleID] in the deep link will default to what is already selected in the app if no vehicleID is attached to the deep link. From c4444e3232c72aa3e1c75c49f5ab002b4d974a88 Mon Sep 17 00:00:00 2001 From: rishoej Date: Thu, 30 Jun 2022 09:57:48 +0200 Subject: [PATCH 2/2] Minor text update --- deep-links.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/deep-links.md b/deep-links.md index 91c9f08..cf4c9c8 100644 --- a/deep-links.md +++ b/deep-links.md @@ -43,7 +43,7 @@ Combine the two into one link and you get a better user friendly experience. | Audi - Video channel | /videoChannel | | Audi - MyGarage | /myGarage | -## Example +### Example Each deep link would look like this for MinVolkswagen: @@ -52,5 +52,3 @@ Each deep link would look like this for MinVolkswagen: or - https://app.minvolkswagen.dk/booking/[vehicleID] - -For all of the ones including [vehicleID] in the deep link will default to what is already selected in the app if no vehicleID is attached to the deep link.