Criar links dinâmicos com a API REST

Você pode criar links dinâmicos curtos com a REST API do Firebase Dynamic Links. 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 links dinâmicos curtos criados com a API e o SDK do cliente (Android/iOS) não são exibidos no Firebase console. 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

  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 Firebase console. 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 Firebase console, 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á 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

Você pode usar a Firebase Dynamic Links API para encurtar um link dinâmico longo. Para tal, faça uma solicitação HTTP POST ao ponto de extremidade shortLinks, especificando o link dinâmico longo no parâmetro longDynamicLink. Por 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 links dinâmicos longos.

Você também pode criar um link dinâmico curto especificando diretamente os parâmetros do link dinâmico. Para tal, faça uma solicitação HTTP POST ao ponto de extremidade shortLinks, especificando os parâmetros do link dinâmico no parâmetro dynamicLinkInfo. Por 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 ver uma especificação completa do objeto dynamicLinkInfo, consulte a referência da API.

Definir o comprimento de um Dynamic Link curto

Você também pode definir o parâmetro suffix para especificar de que modo o componente caminho do link dinâmico é gerado.

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

https://example.page.link/UVWXYZuvwxyz12345

Tais strings são criadas por uma codificação base62 que gera aleatoriamente números de 96 bits. Use essa configuração para evitar que os URLs do seu link dinâmico sejam adivinhados e rastreados, o que poderia expor informações confidenciais para destinatários não desejados.

Se você definir o parâmetro para "SHORT", o componente caminho será uma string somente longa o bastante para ser exclusiva, com limite mínimo de quatro caracteres.

https://example.page.link/WXYZ

Use esse método caso não corra o risco de expor informações confidenciais se o URL do link dinâmico for 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.

A seguir

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 links dinâmicos no seu app, consulte a documentação do iOS, do Android, do C++ e do Unity.

As solicitações têm um limite de 50 consultas por segundo e 100.000 consultas por dia. Se esse limite for excedido, a resposta retornará o código de erro HTTP 429. Para solicitar mais cota, preencha este formulário.

Enviar comentários sobre…

Precisa de ajuda? Acesse nossa página de suporte.