Criar Dynamic Links com a API REST

Você pode criar links dinâmicos curtos com a Firebase Dynamic Links REST API. Essa API aceita links dinâmicos longos ou um objeto que contenha parâmetros de links dinâmicos. Ela também retorna um URL como o seguinte exemplo:

https://example.page.link/WXYZ

Os Dynamic Links curtos criados com a API e o SDK do cliente (Android/Apple) não são exibidos no Console do Firebase. Eles são destinados ao compartilhamento entre usuários. Para casos de uso de marketing, continue a criar seus links diretamente por meio da página do Dynamic Links do Firebase console.

Antes de começar

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.
No Firebase console, abra a seção Dynamic Links.
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á tem um domínio do Dynamic Links, anote-o. Você precisa fornecer um domínio do Dynamic Links ao criar links dinâmicos de maneira programática.

Como criar um link dinâmico curto

Criar um link curto a partir de um longo

Use a API Firebase Dynamic Links para encurtar um Dynamic Link longo. Para fazer isso, faça uma solicitação HTTP POST 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 o artigo Criar um URL manualmente para saber como criar Dynamic Links longos.

Criar um link curto com base nos parâmetros

Também é possível criar um Dynamic Link curto especificando diretamente os parâmetros do Dynamic Link. Para isso, faça uma solicitação HTTP POST ao endpoint shortLinks, especificando os parâmetros de Dynamic Link no parâmetro 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 de 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 Link 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"
   }
}

Verifique se o link direto é válido

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 links dinâmicos, é necessário configurar seu app para receber links dinâmicos e direcionar os usuários ao local correto no seu app após ele ser aberto.

Para receber Dynamic Links no app, veja as documentações 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.