Criar Dynamic Links com a API REST

É possível criar Dynamic Links curtos com a API REST do Firebase Dynamic Links. Esta API aceita um Dynamic Link longo ou um objeto que contém parâmetros de Dynamic Link e retorna um URL como o exemplo a seguir:

https://example.page.link/WXYZ

O Dynamic Links curto criado com a API e o SDK do cliente (Android/Apple) não são exibidos no console Firebase. Esses Dynamic Links são destinados ao compartilhamento entre usuários. Para casos de uso de marketing, continue a criar seus links diretamente na página Dynamic Links do console Firebase.

Antes de começar

  1. Consiga sua chave de API. Você precisará de uma chave de API para autenticar suas solicitações na API. Para encontrar a chave de API:
    1. Abra a página de configurações do console do Firebase. Se você precisar escolher um projeto, selecione seu projeto do Firebase no menu.
    2. Anote o valor do campo Chave de API da Web.
  2. No console do Firebase, abra a seção Dynamic Links.

  3. Se você ainda não aceitou os termos de serviço e definiu um domínio para o Dynamic Links, faça isso quando solicitado.

    Se você já tiver um domínio Dynamic Links, anote-o. É necessário fornecer um domínio Dynamic Links ao criar Dynamic Links de maneira programática.

Use a API Firebase Dynamic Links para encurtar um Dynamic Link longo. Para isso, faça uma solicitação POST HTTP para o endpoint shortLinks, especificando o Dynamic Link longo no parâmetro longDynamicLink. Exemplo:

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

Consulte Criar um URL manualmente para saber como criar um Dynamic Links longo.

Você também pode criar um Dynamic Link curto especificando os parâmetros Dynamic Link. diretamente. Para isso, faça uma solicitação HTTP POST ao endpoint shortLinks, especificando os parâmetros Dynamic Link no dynamicLinkInfo. Exemplo:

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

Para uma especificação completa do objeto dynamicLinkInfo, consulte a referência da API.

Definir o comprimento de um Dynamic Link curto

Também é possível definir o parâmetro suffix para especificar como o componente do caminho do Dynamic Link curto é gerado.

Por padrão, ou se você definir o parâmetro como "UNGUESSABLE", o componente do caminho será uma string de 17 caracteres, como no exemplo a seguir:

https://example.page.link/UVWXYZuvwxyz12345

Essas strings são criadas por números de 96 bits gerados aleatoriamente por codificação base62. Use essa configuração para evitar que os URLs do seu Dynamic Links sejam adivinhados e rastreados, o que poderia expor informações confidenciais para destinatários não desejados.

Se você definir o parâmetro como "SHORT", o componente do caminho será uma string longa o bastante para ser única, com tamanho mínimo de quatro caracteres.

https://example.page.link/WXYZ

Use esse método para não expor informações confidenciais caso um URL de Dynamic Link curto seja adivinhado.

O exemplo a seguir mostra como definir o parâmetro 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"
   }
}

No mínimo, o valor do link direto fornecido precisa começar com esquemas http:// ou https://. Ele também precisa corresponder a qualquer lista de permissões de padrões de URL inserida no console. Caso contrário, a API de criação falhará com o código de erro HTTP 400.

Próximas etapas

Agora que você criou Dynamic Links, é necessário configurar seu app para receber Dynamic Links e direcionar os usuários ao local correto no app quando eles forem abertos.

Para receber Dynamic Links no app, consulte a documentação para iOS, Android, C++ e Unity.

Há um limite de cinco solicitações/endereço IP/segundo e 200 mil solicitações/dia. Se esse limite for excedido, a resposta retornará o código de erro HTTP 429. Para solicitar mais cota, preencha este formulário.