Создание динамических ссылок с помощью REST API

Вы можете создавать короткие Dynamic Links с помощью REST API Firebase Dynamic Links. Этот API принимает либо длинную Dynamic Link , либо объект, содержащий параметры Dynamic Link , и возвращает URL-адрес, как в следующем примере:

https://example.page.link/WXYZ

Короткие Dynamic Links созданные с помощью API и клиентского SDK (Android/Apple), не отображаются в консоли Firebase . Такие Dynamic Links предназначены для обмена данными между пользователями. В маркетинговых целях продолжайте создавать ссылки непосредственно на странице Dynamic Links консоли Firebase .

Прежде чем начать

  1. Получите свой ключ API. Он понадобится вам для аутентификации запросов к API. Чтобы найти свой ключ API:
    1. Откройте страницу настроек консоли Firebase . Если вам будет предложено выбрать проект, выберите свой проект Firebase в меню.
    2. Обратите внимание на значение поля «Ключ веб-API» .
  2. В консоли Firebase откройте раздел Dynamic Links .

  3. Если вы еще не приняли условия обслуживания и не указали домен для Dynamic Links , сделайте это при появлении соответствующего запроса.

    Если у вас уже есть домен Dynamic Links , обратите на это внимание. Вам необходимо указать домен Dynamic Links при программном создании Dynamic Links .

Вы можете использовать Firebase Dynamic Links API для сокращения длинной Dynamic Link . Для этого отправьте HTTP-запрос POST к конечной точке shortLinks , указав длинную Dynamic Link в параметре longDynamicLink . Например:

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"
}

Чтобы узнать, как создавать длинные Dynamic Links , см. раздел Создание URL-адреса вручную.

Вы также можете создать короткую Dynamic Link , указав параметры Dynamic Link напрямую. Для этого отправьте HTTP-запрос POST к конечной точке shortLinks , указав параметры Dynamic Link в параметре dynamicLinkInfo . Например:

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"
    }
  }
}

Полную спецификацию объекта dynamicLinkInfo см. в справочнике API .

Установите длину короткой Dynamic Link

Вы также можете задать параметр suffix , чтобы указать, как генерируется компонент пути короткой Dynamic Link .

По умолчанию или если параметру присвоено значение "UNGUESSABLE" , компонент пути будет представлять собой строку из 17 символов, как в следующем примере:

https://example.page.link/UVWXYZuvwxyz12345

Такие строки создаются путём кодирования случайных 96-битных чисел в формате Base62. Используйте этот параметр, чтобы предотвратить перехват и сканирование URL-адресов Dynamic Links , что может привести к раскрытию конфиденциальной информации непреднамеренным получателям.

Если параметру присвоено значение "SHORT" , компонент пути будет представлять собой строку, длина которой будет соответствовать требованиям уникальности, минимальная длина которой составит 4 символа.

https://example.page.link/WXYZ

Используйте этот метод, если конфиденциальная информация не будет раскрыта при угадывании короткого URL-адреса Dynamic Link .

В следующем примере показано, как можно задать параметр 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"
   }
}

Значение deeplink должно начинаться как минимум со схем http:// или https://. Оно также должно соответствовать любому белому списку шаблонов URL, введённому в консоли. В противном случае API создания завершится сбоем с кодом ошибки HTTP 400.

Следующие шаги

Теперь, когда вы создали Dynamic Links , вам нужно настроить свое приложение для получения Dynamic Links и перенаправлять пользователей в нужное место в вашем приложении после того, как пользователь откроет их.

Чтобы получить Dynamic Links в своем приложении, ознакомьтесь с документацией для iOS , Android , C++ и Unity .

Количество запросов ограничено 5 запросами на IP-адрес в секунду и 200 000 запросов в день. При превышении этого лимита будет возвращен код ошибки HTTP 429. Чтобы запросить дополнительную квоту, заполните эту форму .