How can we help?

Use a OneLink API para criar links em campanhas de grande escala Premium

  • Atualizado

Resumo: a OneLink API te ajuda a engajar usuários finais usando suas mídias próprias, criando links personalizados em campanhas em grande escala, via SMS e mais. Use-o para criar jornadas integradas e sem fricção entre canais, aprofundar o engajamento e melhorar a conversão.

OneLink API

A API OneLink é um recurso premium que permite transformar qualquer canal próprio em um caminho direto para o seu app mobile. Ao gerar links curtos personalizados de forma programática, você pode oferecer jornadas do usuário customizadas em escala, aprofundar o engajamento e impulsionar mais conversões em SMS, e-mail, sites, posts sociais e muito mais. Forneça o OneLink ID e a chave da OneLink API ao desenvolvedor.

  • https://dev.appsflyer.com/hc/reference/create-onelink-attribution-link
  • Parâmetros relacionados à atribuição, usados para mensurar e monitorar esforços de marketing, como canal de mídia, campanha e asset.Atenção: O parâmetro de canal de mídia (pid) é obrigatório.
  • Parâmetros de personalização, que permitem configurar uma experiência de usuário personalizada ao abrir o aplicativo a partir de um link relevante. Esses parâmetros permitem que você envie usuários para um conteúdo personalizado no aplicativo. Por exemplo, uma página de produto específica, código de cupom ou promoção.
  • Gere grandes volumes de links curtos e QR codes automaticamente. 
  • Personalize o TTL (Time To Live) e o comportamento de renovação por caso de uso. Saiba mais
  • Aplique uma validação rigorosa de parâmetros para garantir um comportamento de redirecionamento previsível e uma mensuração confiável.
  • Consulte o uso da cota para gerenciar o consumo.
     

 Exemplo

Um aplicativo global de viagens gera milhões de links curtos contextuais diariamente em experiências de CRM, e-mail e QR. Usando a API OneLink v2.0, a plataforma de automação cria deep links por usuário que respeitam localidade, nível de fidelidade e destinos específicos in-app — ao mesmo tempo em que mantém a governança e a mensuração consistente em todos os mercados. Copie o ID do template do OneLink.

Iniciar

A OneLink API é um recurso premium que é usado para:

Pré-requisito: Uma conta da AppsFlyer. Para acessar a API OneLink, fale com o seu CSM ou envie uma mensagem para hello@appsflyer.com. 

Para configurar a OneLink API:

  1. Copie o token da OneLink API.
  2. Crie um template do OneLink.
  3. Todas as solicitações feitas após ultrapassar essa cota não são atendidas, e os links não são criados; a chamada de API recebe o código de erro 429 com a mensagem "Cota mensal excedida".
     
  4. Compartilhe o ID do template e o token da API com o desenvolvedor e peça que ele siga estas instruções

Painel

O dashboard da OneLink API exibe seu uso diário, mensal e trimestral da API. Isso ajuda você a monitorar seu consumo em relação ao limite da cota mensal. 

Para visualizar o dashboard da OneLink API

Na AppsFlyer, no menu lateral, selecione Engajar > OneLink API.

casos de uso

Os casos de uso a seguir destacam formas comuns de usar a API OneLink para criar jornadas contextuais e sem fricção no seu aplicativo.

Jornadas entre plataformas (CTV, desktop, web-to-app)

Gere links de curta duração ou por sessão que ajudam os usuários a transitar sem fricção entre dispositivos. Exemplos comuns incluem QR codes em anúncios de TV ou fluxos de “escanear para continuar” no desktop que levam os usuários diretamente para a etapa correta in-app.

Valor: Continuidade sem fricção e melhor conversão entre dispositivos.

Canais impulsionados por CRM (SMS, e-mail, WhatsApp)

Crie links curtos personalizados por usuário no momento do envio para mensagens de alta intenção, como alertas de queda de preço, listas de espera, reconquista de usuários, lembretes de cobrança ou fluxos de login mágico.

Valor: Personalização em escala com atribuição consistente.

Engajamento offline e baseado em QR

Produza links escaneáveis para materiais em loja, recibos, embalagens ou sinalização de eventos. Você pode atualizar as configurações de destino sem reimprimir os materiais físicos.

Valor: Roteamento dinâmico e atribuição offline sem reimprimir os materiais físicos.

Compartilhamento de indicações e de defensores

Ative links curtos compartilháveis para programas de indicação de influenciadores, criadores ou clientes, com parâmetros personalizáveis e roteamento pronto para atribuição.

Valor: Mensuração escalável e atribuição precisa para indicações.

Características e limitações

Esta seção lista algumas das principais características e limitações da API OneLink. Diga ao desenvolvedor para seguir as instruções no dev hub.

Caraterística Considerações
Limite de cota da API
  • O limite de uso da OneLink API para criar, editar ou excluir links do OneLink é de 7,5 milhões por mês (fuso horário UTC), por conta.
  • As solicitações POST, PUT e DELETE contam para esse limite. As solicitações GET e GET QR não contam para a cota.
  • Todas as solicitações feitas após exceder essa cota não são atendidas; a chamada de API recebe o código de status 429 com a mensagem "Monthly quota exceeded".
  • Você pode verificar quanto da cota foi usado/quanto ainda resta de uma destas formas:
    • Acessando a página da API OneLink na plataforma AppsFlyer para ver o histórico de uso dos últimos 4 meses, ou
    • Usando a API GET quota para recuperar o status atual da sua cota.
    Você também pode usar a API GET quota para acionar alertas internos quando seu uso se aproximar do limite definido.
Visibilidade do link
  • Os links criados por meio da API não aparecem na lista de links personalizados do OneLink no dashboard da AppsFlyer.

    af_dp 

Atenção

Uma nova versão da API OneLink (v2) foi lançada em dezembro de 2025. A versão anterior (v1) está obsoleta e continuará funcionando até junho de 2026; depois disso, não receberá mais manutenção. Novas integrações devem usar a API OneLink v2. Para obter orientações sobre a migração, consulte o guia de migração no Dev Hub.

This article was translated using AI and may contain errors. For the most accurate information, please refer to the English version using the language selector.


Share article: