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

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

https://example.page.link/WXYZ

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

Прежде чем вы начнете

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

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

Вы можете использовать API динамических ссылок Firebase, чтобы сократить длинную динамическую ссылку. Для этого отправьте запрос HTTP POST к конечной точке shortLinks , указав длинную динамическую ссылку в параметре 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-адреса вручную , чтобы узнать, как создавать длинные динамические ссылки.

Вы также можете создать короткую динамическую ссылку, указав параметры динамической ссылки напрямую. Для этого отправьте запрос HTTP POST к конечной точке shortLinks , указав параметры динамической ссылки в параметре 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 .

Установите длину короткой динамической ссылки

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

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

https://example.page.link/UVWXYZuvwxyz12345

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

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

https://example.page.link/WXYZ

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

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

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

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

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

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