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

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

https://example.page.link/WXYZ

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

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

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

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

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

Вы можете использовать API динамических ссылок Firebase, чтобы сократить длинную 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"
}

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

Вы также можете создать короткую 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

Такие строки создаются путем кодирования base62 случайно сгенерированных 96-битных чисел. Используйте этот параметр, чтобы предотвратить угадывание и сканирование 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"
   }
}

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

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

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

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

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