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 Dynamic Link long ou un objet contenant des paramètres Dynamic Link, et renvoie une URL comme dans l'exemple suivant:

https://example.page.link/WXYZ

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

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 console Firebase. Si vous y êtes invité, 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 votre 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 domaine Dynamic Links lorsque vous créez Dynamic Links par programmation.

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

Consultez Créer manuellement une URL pour savoir comment créer des Dynamic Links longues.

Vous pouvez également créer un Dynamic Link court en spécifiant directement les paramètres Dynamic Link. 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. 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 durée d'un Short Dynamic Link

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

Par défaut, ou si vous définissez le paramètre sur "UNGUESSABLE", le composant de chemin d'accès est 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 vos URL Dynamic Links d'être devinées et explorées, ce qui peut potentiellement exposer des informations sensibles à des destinataires non intentionnels.

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

https://example.page.link/WXYZ

Utilisez cette méthode si les informations sensibles ne sont pas exposées si une URL Dynamic Link courte est 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"
   }
}

La valeur du lien profond fournie doit au minimum commencer par les schémas http:// ou https://. Elle doit également correspondre à toute liste blanche de formats d'URL saisie dans la console. Sinon, l'API de création échoue 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 emplacement 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 supplémentaire, remplissez ce formulaire.