Como usar a API de auditoria de SEO do Ahrefs

Nossa API de auditoria de SEO é a maneira mais poderosa de dimensionar a criação de auditorias de SEO totalmente personalizadas e integrar relatórios avançados de SEO em seus processos de vendas.

O que a API de auditoria de SEO faz?

Ahrefs gera milhares de auditorias de SEO por semana via API para clientes de agências digitais em todo o mundo. O principal caso de uso para agências é a capacidade de criar auditorias de sites dinamicamente e de maneira programática, acionadas como parte de fluxos de trabalho de prospecção de novos negócios.

Algumas agências também criaram suas próprias ferramentas de auditoria (oferecidas publicamente ou somente internas) e usam os pontos de dados do Ahrefs para complementar suas outras métricas.

Mas a API de auditoria de SEO não é apenas para agências digitais, ela também é popular entre pesquisadores, editores e desenvolvedores que precisam de acesso a pontos de dados de SEO para milhares de sites em grande escala.

Nossa API de auditoria de SEO retorna extratos completos de dados (mais de 70 verificações de auditoria individuais) e, opcionalmente, a capacidade de baixar PDFs de relatórios personalizáveis ​​prontos para o cliente.

Primeiros passos com a API de auditoria de SEO em 3 etapas fáceis

Elaboramos este guia para servir como um guia passo a passo sobre como testar, configurar e implementar a API de auditoria de SEO.

Etapa 1: Assine um plano de API Ahrefs

Você precisará de um plano de API de SEO antes de começar. A primeira decisão a tomar é tentar estimar quantos relatórios você provavelmente solicitará por meio da API SEO por mês, pois isso determinará qual plano de API é mais adequado para suas necessidades. Nosso plano de API de nível básico (BR-API-1) oferece cota mensal de 500, o que permite criar 500 relatórios por mês.

Ler:  Site imobiliário: 8 dicas úteis para tornar o seu um sucesso

No outro extremo do espectro, temos um plano Personalizado que permite um volume muito elevado de solicitações (>10.000 por mês). Você precisará entrar em contato conosco por chat ao vivo para que possamos entender melhor seu caso de uso e requisitos de uso. Isso nos permitirá fornecer um preço personalizado.

Lembre-se de que sua cota mensal conta apenas quantos relatórios você cria (independentemente de incluírem ou excluirem o relatório em PDF). Não contabilizamos cada recuperação de relatório ou download de PDF como parte de sua cota mensal.

Todos os planos de API de SEO contêm os mesmos recursos. A única diferença é o volume de relatórios por mês.

Etapa 2: configure seu modelo de relatório

Antes de implementar a API de auditoria de SEO em seu fluxo de trabalho ou aplicativo, é útil primeiro configurar seu modelo de relatório com etiqueta em branco, pois isso determina a aparência do seu relatório e permite que você personalize completamente quais verificações serão executadas.

Se você não estiver interessado nos relatórios gerados em PDF e estiver interessado apenas nas extrações de dados brutos, poderá pular esta etapa. Mas descobrimos que a maioria dos usuários da nossa API utiliza os relatórios em PDF, por isso é um primeiro passo importante.

Faça login no Ahrefs e clique em Modelos de Relatório. No topo da página, você notará esta mensagem que é importante ter em mente no futuro:

“Observe que, como você é um usuário da API, todas as alterações feitas nas configurações do relatório serão aplicadas às respostas de chamadas da API. Se você tiver integrações ativas dependentes de campos de dados específicos, é possível que elas sejam interrompidas após a aplicação das alterações.”

Ler:  Como limpar o cache do Instagram e melhorar o desempenho do aplicativo

Ao criar um modelo de relatório pela primeira vez, você não precisa se preocupar, mas lembre-se de que se você criar integrações que dependem de pontos de dados da API de auditoria de SEO e modificar o modelo transformando esses pontos de dados desligado, suas integrações serão interrompidas.

Nesta página você pode personalizar completamente a aparência do relatório, fazer upload do seu logotipo, escolher cores, fontes e ativar/desativar todas as diferentes verificações.

Etapa 3: teste a API de auditoria de SEO na linha de comando

Essa é uma ótima maneira de simplesmente testar a API e ver exatamente o que a API retorna, para que você possa começar a pensar sobre a melhor forma de implementar a API como parte de seus processos mais amplos.

Testar na linha de comando é uma maneira rápida e fácil de verificar se tudo está configurado corretamente e funcionando antes de começar a integrar os dados do Ahrefs aos seus sistemas.

Para fazer isso, abra uma nova janela Terminal/Prompt de Comando. Este exemplo foi testado em um PC com Windows 11 (conhecido como v10). Os comandos serão ligeiramente diferentes para Mac e Linux.

Crie um relatório

A maneira mais simples de chamar a API SEO é chamar a API Ahrefs criar ponto final usando ondulação:

curl -H “Tipo de conteúdo: aplicativo/json” -H “x-api-key: ” -d “{\”url\”:\”example.org\”,\”pdf\ “:0}” https://api.seoptimer.com/v1/report/create

Como um breve explicador sobre a sintaxe: -H apoia cabeçalho e -d apoia dados.

Defina o cabeçalho application/json e passe sua chave API Ahrefs (que pode ser recuperada na guia API no Ahrefs):

-H “Tipo de conteúdo: aplicativo/json” -H “x-api-key:

Em seguida, na matriz de dados, defina a URL que deseja auditar (lembre-se de escapar de todas as aspas). Você também pode passar parâmetros opcionais para personalizar ainda mais sua solicitação:

  • pdf:
    • passe 0 (zero) se não quiser que um relatório em PDF seja incluído na resposta
    • passe 1 (um) se desejar que um arquivo de relatório em PDF seja incluído na resposta
  • modelo:
    • passe o ID do modelo de relatório (que pode ser encontrado na URL ao visualizar o modelo no Ahrefs)

-d “{\”url\”:\”example.org\”,\”pdf\”:0}”

Por fim, anexe o URL da API SEO com o criar ponto final:

https://api.seoptimer.com/v1/report/criar

A API SEO retornará a seguinte resposta JSON:

  • sucesso: verdadeiro ou falso
  • dados:
    • url: o URL que você inseriu
    • pdf: verdadeiro ou falso se você solicitar um relatório em PDF
    • ligar de volta: verdadeiro ou falso
    • modelo: se verdadeiro, o ID do modelo solicitado para o relatório ou flase
    • eu ia: um ID de resultado exclusivo para esta solicitação de pesquisa de dados do relatório

No exemplo acima, solicitei um relatório para “example.org” e ele retornou o ID do resultado de 77285. Agora posso usar esse ID de resultado para pesquisar os dados do relatório.

Depois de receber um valor de sucesso de verdadeiro, deduzimos 1 da sua cota mensal de API. Você pode verificar sua cota de uso de API a qualquer momento na guia API do Ahrefs.

Busque os dados do resultado

A busca de dados de resultados não reduz sua cota mensal de API. É apenas o processo de criação do relatório que custa a cota.

Para buscar os dados do relatório, chame o método pegar ponto final seguido pelo ID do resultado que foi retornado na etapa anterior:

curl -H “Tipo de conteúdo: aplicativo/json” -H “x-api-key: ” https://api.seoptimer.com/v1/report/pegar/77285

Como antes, dentro da solicitação, defina o cabeçalho application/json e passe sua chave de API.

A API SEO retornará a seguinte resposta JSON:

  • sucesso: verdadeiro ou falso (observe: nossos sistemas levam alguns segundos para processar um relatório. Se você solicitar os dados do resultado muito rapidamente, receberá uma resposta Success:false)
  • dados: uma longa resposta JSON contendo mais de 70 verificações de auditoria

Você pode copiar a resposta inteira e colá-la em um Formatador JSON para visualizar melhor todas as verificações e valores retornados:

Se você definir PDF como 1, verá um link para download no campo saída->pdf.

Conforme mencionado anteriormente, usar o prompt de comando e inserir URLs um por um não é o caso de uso pretendido da API SEO – mas sim uma maneira prática de testar a API rapidamente e explorar todos os dados retornados antes de criar qualquer integração em seus sistemas ou aplicativos.

Você também pode verificar nossa documentação da API SEO em Carteiro.

Etapa 4: planeje sua integração

Agora que você sabe como chamar a API SEO e entende quais valores são retornados, pode começar a planejar como integrará a API SEO.

A seguir estão algumas ideias de como a API SEO pode agregar valor aos seus fluxos de trabalho de vendas ou aplicativos existentes:

  • Automação de CRM: quando novos clientes potenciais são adicionados ao seu CRM, com base em determinados atributos, você pode usar a API SEO para enriquecer automaticamente o registro do cliente com dados de auditoria do site e gerar um relatório de auditoria dinamicamente
  • Painel de marketing digital: para organizações que já possuem um aplicativo ou painel voltado para o cliente, a API SEO pode ser usada para preencher ou enriquecer ‘widgets’ de SEO em seu aplicativo ou ser usada em relatórios agregados de canal
  • Rastreamento programático: pesquisadores de mercado ou jornalistas do setor podem usar a API SEO para auditar muitos sites e retornar pontos de dados de auditoria do site para serem usados ​​em estudos de pesquisa ou relatórios do setor

Próximos passos

As possibilidades são infinitas sobre como você pode aproveitar os dados da API SEO. Se você estiver planejando uma integração, recomendamos entrar em contato conosco, pois nossa equipe de suporte ao cliente pode ajudar a orientá-lo durante o processo, especialmente se você tiver um caso de uso avançado ou apenas quiser outra opinião sobre a melhor forma de estruturá-lo. Entre em contato conosco através do chat ao vivo no canto inferior direito da tela.

Novas publicações:

Recomendação