Docs
Pesquisar na documentação...⌘K

Como funciona

O Ahrefs Connect permite que seu app acesse dados da API da Ahrefs em nome de um usuário que conecta a conta da Ahrefs ao seu produto.

Veja o fluxo básico:

  1. Seu app se integra à API da Ahrefs via OAuth.
  2. Um usuário em comum com uma assinatura paga da Ahrefs conecta a conta ao seu app.
  3. Seu app solicita dados da Ahrefs em nome desse usuário.
  4. Cada solicitação consome unidades de API da cota mensal desse usuário.
  5. Você processa, armazena e exibe esses dados no seu app para esse usuário.

Requisitos de elegibilidade

Para participar do Ahrefs Connect, seu app precisa:

  • Ser um produto disponível publicamente com uma base de usuários já existente. Se você precisa de dados da Ahrefs para uso pessoal ou interno, use a API da Ahrefs diretamente.
  • Não competir diretamente com a Ahrefs nem copiar nossas funcionalidades.
  • Solicitar dados apenas em nome de usuários individuais da Ahrefs com contas pagas. O Ahrefs Connect não foi projetado para produtos que querem exibir dados da Ahrefs para um público geral sem que cada visualizador seja um usuário da Ahrefs.

Processo

1. Aplicativo

Envie o formulário de inscrição com:

  • Uma descrição do seu produto
  • Um link para o seu site
  • Detalhes de como você pretende usar os dados da Ahrefs no seu app

Nossa equipe Enterprise confirmará se seu produto é elegível, explicará o processo e fornecerá assistência.

2. Plano Empresa

Se você estiver criando uma integração nova (não pertencente ao programa legado), precisará de um plano Ahrefs Enterprise para ativar sua integração em produção.

  • Você não precisa do plano durante o desenvolvimento.
  • Ele é necessário para habilitar a integração para usuários em produção.

Nossa equipe de vendas vai orientar você nesta etapa.

3. Desenvolvimento

Depois que tudo estiver configurado, você encontrará a seção Ahrefs Connect em Configurações da conta. Esta página traz detalhes sobre a implementação de OAuth:

  • IDs de cliente e secrets
  • Campos para definir URIs de redirecionamento para os ambientes de staging e produção

Nesta etapa, o status do seu app será Inativo, permitindo que você:

  • Teste os fluxos de OAuth no seu ambiente de staging
  • Faça solicitações de teste gratuitas para endpoints da API v3

Recursos:

Em caso de dúvidas durante o desenvolvimento, entre em contato com [email protected] ou com o gerente de vendas com quem você esteve em contato.

4. Avaliação

Quando o desenvolvimento estiver concluído, avise nossa equipe de suporte ou de vendas. Eles fornecerão instruções de envio e detalhes sobre os requisitos de aprovação.

Mais informações: Processo de aprovação

5. Ativação

Depois de aprovado, seu app passa para Ativo. Isso habilita:

  • Conexões OAuth ativas para usuários do Ahrefs em produção
  • Acesso completo às solicitações da API em produção

Nossa equipe de vendas também pode adicionar seu app à Galeria de apps, para que os usuários possam encontrá-lo com facilidade. Isso exige o envio de detalhes adicionais do anúncio: guia da Galeria de apps

info

Para desenvolvedores de apps de integração legada

Se o seu app já funciona com nosso programa legado de Integrações:

  • Não é preciso se candidatar: você é migrado automaticamente para o Ahrefs Connect. Você já deve ver a nova seção em Configurações da conta e pode começar a desenvolver com a API v3.
  • Não é necessária uma assinatura Enterprise: como parceiro de longa data, você não precisa assinar o plano Enterprise para ativar seu app.
  • Mesmas etapas restantes: desenvolvimento, revisão e ativação seguem o mesmo processo de apps novos.
  • Detalhes da migração: consulte Para desenvolvedores de apps legados para saber mais sobre como migrar do antigo sistema de API v2 para o novo sistema de API v3.