Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add deep link section #44

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add deep link section #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cf4013
Add deep link section
rishoej Jun 30, 2022
c4444e3
Minor text update
rishoej Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
54 changes: 54 additions & 0 deletions deep-links.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 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.
rishoej marked this conversation as resolved.
Show resolved Hide resolved

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might also be worth mentioning that some deep links has fallbacks (such as service reminders) to web, if the app is not installed.

Maybe a also add a "Fallback" column with "Yes" or "No" value in the deeplinks table further down?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah. I think booking is the only fallback we have at the moment


## 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]