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

Guia da API

Temos uma referência completa e detalhada da API v3 aqui: documentação da API da Ahrefs. Esta página é uma breve introdução para desenvolvedores do Ahrefs Connect.

O que você pode fazer com a API v3

A API v3 da Ahrefs permite extrair uma ampla variedade de dados, incluindo:

  • Dados orgânicos e de Backlinks do Site Explorer (para seu site ou concorrentes)
  • Métricas e ideias de palavras-chave do Keywords Explorer
  • Dados de SERP do Google
  • Dados do Rank Tracker e do Site Audit do usuário
  • E muito mais — adicionamos novos endpoints regularmente

Unidades de API e custos de solicitação

Todas as solicitações — exceto consultas de teste gratuitas e os endpoints de Rank Tracker, Management, Public e alguns outros — consomem unidades de API da conta do usuário conectado.

Regras de custo:

  • Depende do número de linhas retornadas e dos campos solicitados
  • Custo mínimo de qualquer solicitação paga: 50 unidades
  • Se um endpoint for gratuito, isso estará indicado na página de documentação dele

Durante o desenvolvimento

Como explicado em Como funciona, quando seu app é criado pela primeira vez, ele ficará com o status Inativo. Nesse modo, é possível testar fluxos do OAuth e enviar solicitações de teste gratuitas para endpoints da API v3 a partir do seu ambiente de staging, sem consumir unidades. Quando seu app for aprovado e ativado, as solicitações em produção consumirão unidades de acordo com as regras de custo normais.

Leia mais: Consultas de teste gratuitas e Consumo de limites da API

info

Boas práticas para economizar unidades de API do usuário

Ao fazer solicitações em nome dos usuários, leve em conta a cota mensal deles.

Veja como minimizar o consumo de unidades:

  1. Use select para solicitar apenas os campos necessários: a maioria dos endpoints permite especificar campos.
  2. Limite o número de linhas: use limit ou parâmetros equivalentes. Evite buscar milhares de linhas, a menos que seja necessário.
  3. Use endpoints em massa quando possível: por exemplo, batch-analysis permite extrair métricas de muitas páginas em uma única solicitação.
  4. Permita que os usuários acompanhem o uso: o endpoint limits-and-usage mostra quantas unidades ainda restam.