Deeplinks

Deeplinks are special links to open specific pages or sections inside your app. They follow a pattern and can include information about wich page to open and wich details to show up or load.

Eitri App Shopping comes from out of box with an integrated solution to resolve most common deeplinks used in main ecommerce providers but letting you setup your customized rules, routes and paths.

There are two types of deeplinks that we will talk about in this documentation:

Traditional deeplinks
Universal Link (iOS) / App Link (Android)

Requirements

To use deeplinks with Eitri you will need:

A deeplink resolver addon setup ready in you Eitri App.
If you are using default deeplink resolver, you need to ask for activation to Eitri team.
If you plan to use Universal Links (iOS) or App Links (Android) you need to setup your website well-know files as explained in this documentation.

Traditional deeplinks

Deeplinks that use an specific opening protocol to open your app in user's device.

Example: myapp://category/female/jeans

App Link (Android) / Universal Link (iOS)

They need an specific setup in your website to be bound to your domain. Once it's configured, users that have your app installed will be redirected from web site pages directly to your app in respective app pages.

You will need to configure your website to have 2 files hosted in specific paths to work with Android and iOS. Those files will be provided by Eitri.

With most e-commerce providers you can create/update those files by opening a ticket asking for it.

App Link (Android)

File path: https://www.mywebsite.com/.well-known/assetlinks.json

File example:

[{
    "relation": ["delegate_permission/common.handle_all_urls"],
    "target" : { 
        "namespace": "android_app", 
        "package_name": "app_bundle_id",
        "sha256_cert_fingerprints": ["app_bundle_fingerprint"] 
    }
}]

Where:

app_bundle_id is your app bundle id in Google Play store.

Example: com.myapp.store

app_bundle_fingerprint is sha256 fingerprint generated for your app.

Example: F8:57:A0:0C:AB:8B:B2:59:92:F7:3D:1D:38:6C:05:17:A8:3F:B1:19:B5:E7:05:5F:ED:B5:B8:27:EA:0C:E3:57

Universal Link (iOS)

File path: https://www.mywebsite.com/.well-known/apple-app-site-association

File example:

{
  "applinks": {
    "apps": [],
    "details": [
      {
        "appID": "app_bundle_id",
        "paths": [
          "*"
        ]
      }
    ]
  }
}

Where:

app_bundle_id is your app bundle id in Apple App Store.

Example: com.myapp.store

paths are the url patterns that you want to redirect to your app

Example: "*/p" redirects all urls finishing with "/p" to app since usually they are product pages.

Structure

Deeplinks may have different structures based on what they do but they have basically 3 main parts:

prefix://action/params

Supported actions

Eitri App Shopping supports the following a lot of actions for deeplinks by default:

Open Product

prefix://product/id/product_id
or
prefix://product/slug/product_slug

Where:

prefix = prefix used for your app
product_id = product id to open (you should use product id, not sku id)
product_slug = product slug to open (you can get it from your vtex website for example)

Vtex website product pages usually ends with "/p". You need to remove it since it's not part of product slug.

Examples:

myapp://product/id/348764
myapp://product/slug/altra-lone-peak-9-trail-running-shoe-mens-10595101

Open Category

prefix://category/path_to_category

Where:

prefix = prefix used for your app
path_to_category = full path to category (like: female/jeans)

Examples:

myapp://category/male
myapp://category/female/jeans
myapp://category/kids/clothes/pants

Open Search

prefix://search/term_to_search

Where:

prefix = prefix used for your app
term_to_search = term(s) to search

We recommend that you uri encode the search content to ensure your special characters and spaces are correctly readed. Example: "male jeans" should be passed as "male%20jeans".

Examples:

myapp://search/shirts
myapp://search/leather%20jackets
myapp://search/kids%eletronic%20toys

Open Collection

prefix://collection?filter=collection_id&O=order

Where:

prefix = prefix used for your app
collection_id = numeric id to collection
order = order used to show items from collection

Order options:

OrderByPriceDESC: Higher price first
OrderByPriceASC: Lower price first
OrderByTopSaleDESC: Top sales first
OrderByReviewRateDESC: Better reviews first
OrderByNameDESC: Z-A
OrderByNameASC: A-Z
OrderByReleaseDateDESC: Release date first
OrderByBestDiscountDESC: Better discount first
OrderByScoreDESC: Better score first

Examples:

myapp://collection?filter=55678&O=OrderByPriceASC
myapp://collection?filter=55739&O=OrderByBestDiscountDESC

Open Browser/URL

prefix://webview/inapp/url

Where:

url = prefix used for your app
'inapp' (optional) = if used, it will open the URL inside internal app webview

We recommend that you uri encode the URL content to ensure your special characters are correctly readed. Example: "https://www.mywebsite.com.br/male/shirts" should be passed as "https%3A%2F%2Fwww.mywebsite.com.br%2Fmale%2Fshirts".

Examples:

myapp://webview/https%3A%2F%2Fwww.mywebsite.com.br%2Fmale%2Fshirts