Créer des liens dynamiques avec l'API REST

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

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 Firebase console.Dynamic Links Ces Dynamic Links sont destinés au partage entre utilisateurs. Pour les cas d'utilisation marketing, continuez à créer vos liens directement sur la Dynamic Links page de la Firebase console.

Avant de commencer

  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 Firebase console. Si vous êtes invité à choisir un projet, sélectionnez votre projet Firebase dans le menu.
    2. Notez la valeur du champ Clé API Web.
  2. Dans la console Firebase, ouvrez la section Dynamic Links.
  3. Si vous n'avez pas encore accepté les conditions d'utilisation et défini un domaine pour vos Dynamic Links, faites-le lorsque vous y êtes invité.

    Si vous possédez déjà un domaine Dynamic Links, notez-le. Vous devez fournir un Dynamic Links domaine lorsque vous créez Dynamic Links de manière automatisée.

Vous pouvez utiliser l'API Firebase Dynamic Links pour raccourcir un lien dynamique long Dynamic Link. Pour ce faire, envoyez une requête HTTP POST au point de terminaison shortLinks, en spécifiant le lien dynamique long Dynamic Link dans le paramètre longDynamicLink. 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"
}

Pour savoir comment créer des liens dynamiques longs, consultez Créer manuellement une URL pour savoir comment créer des liens dynamiques longs Dynamic Links.

Vous pouvez également créer un court Dynamic Link en spécifiant directement les paramètres Dynamic Link. Pour ce faire, envoyez une requête HTTP POST au shortLinks point de terminaison, en spécifiant les Dynamic Link paramètres dans le dynamicLinkInfo paramètre. 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 obtenir une spécification complète de l'objet dynamicLinkInfo, consultez la documentation de référence de l'API.

Définir la longueur d'un court Dynamic Link

Vous pouvez également définir le paramètre suffix pour spécifier comment le composant de chemin d'accès du court Dynamic Link est généré.

Par défaut, ou si vous définissez le paramètre sur "UNGUESSABLE", le composant de chemin d'accès 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 de 96 bits générés de manière aléatoire. Utilisez ce paramètre pour empêcher que les URL de vos Dynamic Links ne soient devinées et explorées, ce qui pourrait exposer des informations sensibles à des destinataires non souhaités.

Si vous définissez le paramètre sur "SHORT", le composant de chemin d'accès sera une chaîne dont la longueur minimale est de quatre caractères et qui ne sera pas plus longue que nécessaire pour être unique.

https://example.page.link/WXYZ

Utilisez cette méthode si des informations sensibles ne seraient pas exposées si une URL Dynamic Link courte é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 du lien profond fournie doit commencer par les schémas http:// ou https://. Elle doit également correspondre à tous les modèles d'URL autorisés saisis dans la console. Sinon, l'API de création échouera avec le code d'erreur HTTP 400.

Étapes suivantes

Maintenant que vous avez créé Dynamic Links, vous devez configurer votre application pour qu'elle reçoive Dynamic Links et redirige les utilisateurs vers le bon endroit de votre application après qu'ils les ont ouverts.

Pour recevoir Dynamic Links dans votre application, consultez la documentation pour iOS, Android, C++, et Unity.

Les requêtes sont limitées à cinq requêtes par adresse IP et par seconde, et à 200 000 requêtes par jour. Si cette limite est dépassée, la réponse renvoie le code d'erreur HTTP 429. Pour demander un quota plus élevé, remplissez ce formulaire.