Comprendre et utiliser le Deep Link

Le Deep Link ou Deep Linking permet de façon claire et simple de diriger les utilisateurs vers un contenu spécifique de l’Application Mobile Kizeo Forms. Pour cela, il suffit de leur fournir un lien hypertext contenant le formalisme requis.

Qu’est-ce qu’un Deep Link ?

Un Deep Link est une URL, c’est à dire une adresse Web, mais son formalisme est un peu différent de l’URL classique. En effet, une URL classique commence par https:// alors que le Deep Link commence par kizeoforms://. Cette spécificité fait que certains logiciels n’interprètent pas ce lien comme une URL et ne le rendent pas cliquable. 

Pour le rendre fonctionnel, il suffit de créer un lien hypertext et de le transmettre à vos utilisateurs, dans un logiciel compatible. Ainsi, en cliquant sur le lien, Android et iOS redirigent l’URL vers l’Application KizeoForms.

Le formalisme du Deep Link

Les règles de base

Les règles suivantes doivent impérativement être respectées :

• Pour ouvrir les liens, il faut impérativement être Utilisateur de l’Application Kizeo Forms.
• Le Deep Link commence toujours par kizeoforms://--/
• Il s’écrit toujours en minuscule, sans accent, et sans espace.
• Les caractères spéciaux doivent être encodés.
• Le formalisme doit être respecté au caractère près.
• Le Deep Link doit être mis sous la forme d’un lien hypertext.

Qu'est-ce que l'encodage-pourcent ?

C’est un mécanisme d’encodage de certains caractères utilisé dans le contexte des URLs. Il consiste en la substitution d’un caractère par % suivi d’un code hexadécimal correspondant à la valeur ASCII du caractère à remplacer.

Le tableau suivant présente les caractères spéciaux avec leur encodage respectif :

Les champs compatibles avec le Deep Linking

Il est possible de préremplir uniquement certains champs, à condition qu’ils ne se trouvent pas dans un tableau. En voici la liste :

• Le Champ de Saisie
• Le Champ Zone de Texte
• Le Champ Date et Heure
• Le Champ Case à Cocher
• Le Champ Slider
• Le Champ Liste. S’il s’agit d’une Liste Externe Référentielle, les références de la Liste Externe s’afficheront automatiquement dans les Champs Référence liés.
• Le Champ Choix
• Le Champ Géolocalisation
• Le Champ Code-barres/QR Code
• Le Champ Tag NFC
• Le Champ Calcul. Il est possible de mettre un Deep Link dans un champ de type Calcul.

Les formalismes particuliers

Si la plupart des champs acceptent les chaînes de caractères, certains ont un formalisme particulier. Par exemple :

• Case à Cocher cochée : 1, ‘1’, true ou ‘true’. Toute autre valeur sera interprétée comme faux (false).
• Date : YYYY-MM-DD
• Heure : hh:mm:ss
• Date et Heure : YYYY-MM-DDThh:mm:ss. Il convient de mettre T entre la date et l’heure.

Cas pratiques

1. Les Deep Link génériques

Avec les liens de base, voici ce qu’il est possible de faire :

• kizeoforms://--/ permet d’ouvrir l’application Kizeo Forms
• kizeoforms://--/login permet l’accès à la page d’authentification
• kizeoforms://--/login/code permet l’accès à la page d’authentification avec un code entreprise pré-rempli. code doit être remplacé par le code entreprise souhaité
• kizeoforms://--/forms permet l’accès à la liste des formulaires
• kizeoforms://--/favorites permet l’accès à la liste des formulaires favoris
• kizeoforms://--/settings permet l’accès aux paramètres de l’application
• kizeoforms://--/forms/formId permet d’entrer dans la saisie d’une donnée sur le formulaire qui correspond au formId
• kizeoforms://--/data permet l’accès à la liste des données saisies
• kizeoforms://--/receipts permet l’accès à la boîte de réception

2. Les Deep Link personnalisés

Bien qu’il ne se substitue pas au Push, le Deep Linking permet de préremplir des champs d’un formulaire, grâce aux Deep Link personnalisés.

Le formalisme d’un Deep Link personnalisé est le suivant : kizeoforms://--/forms/formId?tag1=valeur1&tag2=valeur2&tag3=valeur3

• formId doit être remplacé par l’ID du formulaire. Il s’agit de la référence à 6 chiffres qui se trouve dans l’URL de la page de création du formulaire
• tag1, tag2, tag3 etc… correspondent à l’identifiant des champs
• valeur1, valeur2, valeur3 etc… sont les valeurs qui seront saisies

Voyons quelques cas concrets, en utilisant les champs suivants avec leurs identifiants respectifs.

1. Remplir un champ

Nous souhaitons mettre le nom Kizeo Forms dans le Champ de saisie du formulaire dont l’id est 123456.

L’espace entre Kizeo et Forms est un caractère spécial, son code est %20 

Le formalisme est : kizeoforms://--/forms/formid?nom_du_champ=KizeoespaceForms

Le lien sera : kizeoforms://--/forms/123456?champ_de_saisie1=Kizeo%20Forms

2. Remplir un champ avec des retours à la ligne

Nous souhaitons mettre l’adresse de Kizeo avec des retours à la ligne dans le champ Zone de texte du formulaire dont l’id est 123456.

Les caractères spéciaux :

• L’espace entre les mots, son code est %20
• Le é de Allée, son code est %C3%A9
• Le retour à la ligne dans l’adresse, son code est %5Cn

kizeoforms://--/forms/formid?nom_du_champ=55espaceAlléeespaceCamilleespaceClaudelretour à la ligne84000espaceAvignon

kizeoforms://--/forms/123456?zone_de_texte1=55%20All%C3%A9e%20Camille%20Claudel%5Cn84000%20Avignon

3. Remplir plusieurs champs

Nous souhaitons mettre le nom Kizeo Forms dans le Champ de Saisie et l’adresse de Kizeo avec des retours à la ligne dans le Champ Zone de Texte du formulaire dont l’id est 123456.

Les caractères spéciaux :

• L’espace entre les mots, son code est %20
• Le é de Allée, son code est %C3%A9
• Le retour à la ligne dans l’adresse, son code est %5Cn
• Le et entre deux éléments saisis, son code est &

kizeoforms://--/forms/formid?nom_du_champ=KizeoespaceForms&nom_du_champ=55espaceAlléeespaceCamilleespaceClaudelretour à la ligne84000espaceAvignon

kizeoforms://--/forms/123456?champ_de_saisie1=Kizeo%20Forms&zone_de_texte1=55%20All%C3%A9e%20Camille%20Claudel%5Cn84000%20Avignon

4. Remplir un champ Case à cocher

Nous souhaitons cocher la case du champ dont l’identifiant est ouinon

Formule : kizeoforms://--/forms/formid?nom_du_champ=1 (ou nom_du_champ=true)

Lien : kizeoforms://--/forms/123456?ouinon=1 (ou ouinon=true)

5. Remplir un champ Date et Heure

• Nous souhaitons afficher la date du 24 Novembre 2022 dans le champ dateseule
  Formule : kizeoforms://--/forms/formid?nom_du_champ=YYYY-MM-DD
  Lien : kizeoforms://--/forms/123456?dateseule=2022-11-24
• Nous souhaitons afficher l’heure 11h56 dans le champ heure
  Formule : kizeoforms://--/forms/formid?nom_du_champ=hh:mm:ss
  Lien : kizeoforms://--/forms/123456?heure=11:56:00
• Nous souhaitons afficher la date du 24 Novembre 2022 et l’heure 11h56 dans le champ date_et_heure1
  Formule : kizeoforms://--/forms/formid?nom_du_champ=YYYY-MM-DD
  Lien : kizeoforms://--/forms/123456?date_et_heure1=2022-11-24T11:56:00