Catch up on highlights from Firebase at Google I/O 2023. Learn more

Créer des liens dynamiques avec l'API REST

Vous pouvez créer des liens dynamiques courts avec l'API REST Firebase Dynamic Links. Cette API accepte soit un lien dynamique long, soit un objet contenant des paramètres de lien dynamique, et renvoie une URL comme dans l'exemple suivant :

https://example.page.link/WXYZ

Les liens dynamiques courts créés avec l'API et le SDK client (Android/Apple) ne s'affichent pas dans la console Firebase. Ces liens dynamiques sont destinés au partage d'utilisateur à utilisateur. Pour les cas d'utilisation marketing, continuez à créer vos liens directement via la page Liens dynamiques de la console Firebase.

Avant que tu commences

  1. Obtenez votre clé API. Vous aurez besoin d'une clé API pour authentifier vos requêtes auprès de l'API. Pour trouver votre clé API :
    1. Ouvrez la page Paramètres de la console Firebase. Si vous êtes invité à choisir un projet, sélectionnez votre projet Firebase dans le menu.
    2. Prenez note de la valeur du champ Web API Key .
  2. Dans la console Firebase, ouvrez la section Liens dynamiques .
  3. Si vous n'avez pas encore accepté les conditions d'utilisation et défini un domaine pour vos liens dynamiques, faites-le lorsque vous y êtes invité.

    Si vous avez déjà un domaine Dynamic Links, notez-le. Vous devez fournir un domaine Dynamic Links lorsque vous créez des liens dynamiques par programmation.

Vous pouvez utiliser l'API Firebase Dynamic Links pour raccourcir un long lien dynamique. Pour ce faire, envoyez une requête HTTP POST au point de terminaison shortLinks , en spécifiant le lien dynamique long dans le paramètre longDynamicLink . Par exemple:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
   "longDynamicLink": "https://example.page.link/?link=https://www.example.com/&apn=com.example.android&ibi=com.example.ios"
}

Voir Construire manuellement une URL pour savoir comment créer des liens dynamiques longs.

Vous pouvez également créer un lien dynamique court en spécifiant directement les paramètres du lien dynamique. Pour ce faire, envoyez une requête HTTP POST au point de terminaison shortLinks , en spécifiant les paramètres Dynamic Link dans le paramètre dynamicLinkInfo . Par exemple:

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
  "dynamicLinkInfo": {
    "domainUriPrefix": "https://example.page.link",
    "link": "https://www.example.com/",
    "androidInfo": {
      "androidPackageName": "com.example.android"
    },
    "iosInfo": {
      "iosBundleId": "com.example.ios"
    }
  }
}

Pour une spécification complète de l'objet dynamicLinkInfo , consultez la référence API .

Définir la longueur d'un lien dynamique court

Vous pouvez également définir le paramètre suffix pour spécifier comment le composant de chemin du lien dynamique court est généré.

Par défaut, ou si vous définissez le paramètre sur "UNGUESSABLE" , le composant de chemin sera une chaîne de 17 caractères, comme dans l'exemple suivant :

https://example.page.link/UVWXYZuvwxyz12345

Ces chaînes sont créées en encodant en base62 des nombres 96 bits générés de manière aléatoire. Utilisez ce paramètre pour empêcher que vos URL de liens dynamiques soient devinées et explorées, ce qui peut potentiellement exposer des informations sensibles à des destinataires involontaires.

Si vous définissez le paramètre sur "SHORT" , le composant de chemin sera une chaîne qui n'est aussi longue que nécessaire pour être unique, avec une longueur minimale de 4 caractères.

https://example.page.link/WXYZ

Utilisez cette méthode si des informations sensibles ne seraient pas exposées si une courte URL de lien dynamique était devinée.

L'exemple suivant montre comment définir le paramètre suffix :

POST https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=api_key
Content-Type: application/json

{
   "longDynamicLink": "https://example.page.link/?link=http://www.example.com/&apn=com.example.android&ibi=com.example.ios",
   "suffix": {
     "option": "UNGUESSABLE"
   }
}

Au minimum, la valeur de lien profond fournie doit commencer par les schémas http:// ou https://. Il doit également correspondre à toute liste blanche de modèles d'URL entrée dans la console. Sinon, l'API de création échouera avec le code d'erreur HTTP 400.

Prochaines étapes

Maintenant que vous avez créé des liens dynamiques, vous devez configurer votre application pour recevoir des liens dynamiques et envoyer les utilisateurs au bon endroit dans votre application après qu'un utilisateur les a ouvertes.

Pour recevoir des liens dynamiques dans votre application, consultez la documentation pour iOS , Android , C++ et Unity .

Les requêtes sont limitées à 5 requêtes/adresse IP/seconde et 200 000 requêtes/jour. En cas de dépassement, la réponse renverra le code d'erreur HTTP 429. Pour demander plus de quota, remplissez ce formulaire .