Referência da API REST
Integre a verificação de indexação em massa diretamente nos seus painéis, ferramentas ou scripts. Automatize o seu fluxo de SEO com a nossa API de alto desempenho.
A API REST do IndexChecker permite criar projetos de verificação, ler o estado de indexação e consultar o saldo de créditos a partir dos seus scripts e painéis. Cada pedido é autenticado com a sua chave de API secreta no corpo POST, os endpoints devolvem JSON, um projeto aceita até 50.000 URL e 1 crédito verifica 1 URL.
Que endpoints tem a API do IndexChecker?
| Endpoint | Método | Finalidade |
|---|---|---|
| /api/project/create | POST | Criar um projeto de verificação a partir de uma lista de URL |
| /api/project/show | POST | Obter o estado, as estatísticas e os links de um projeto |
| /api/project/show_all | POST | Listar todos os seus projetos |
| /api/project/delete | POST | Eliminar um projeto de forma permanente |
| /api/check-balance | POST | Consultar o saldo atual de créditos |
Primeiros passos
Conta
Autenticação
Autentique os seus pedidos incluindo a sua chave de API secreta no corpo do pedido (parâmetros POST).
Pode encontrar e gerir a sua chave de API nas definições do painel.
Aviso de segurança: Mantenha a sua chave de API segura. Não a partilhe em código acessível publicamente (por exemplo, JS do lado do cliente).
Criar projeto
Crie um novo projeto de verificação com uma lista de URL.
A sua chave de API secreta.
Nome do projeto.
Lista de URL separados por uma barra vertical |.
-d "apikey=YOUR_API_KEY" \
-d "project_name=MyProject" \
-d "urls=https://site1.com|https://site2.com"
"error": 0,
"message": "project MyProject has been added in it 2 links.",
"project_name": "MyProject",
"procjet_id": 154,
"project_id": 154,
"add_links_count": 2
}
Obter detalhes do projeto
Obtenha o estado, as estatísticas e os links de um projeto específico.
ID do projeto que pretende obter.
"project_name": "MyProject",
"description": "optional description",
"date_created": "2023-10-12 14:30:00",
"project_id": "154",
"urls": {
"https://site1.com": "1",
"https://site2.com": "-1"
},
"statistics": {
"total_links": 2,
"indexed": 1,
"not_indexed": 0,
"pending": 1,
"percentage": 50
}
}
Listar todos os projetos
Obtenha a lista de todos os seus projetos.
"154": {
"project_name": "MyProject",
"description": "",
"date_created": "2023-10-12 14:30:00"
},
"155": {
"project_name": "Another Project",
"description": "SEO Audit",
"date_created": "2023-10-13 09:15:00"
}
}
Eliminar projeto
Remova de forma permanente um projeto e todos os dados associados.
ID do projeto a eliminar.
"id": "154",
"error": 0,
"message": "The MyProject project has been deleted"
}
Consultar saldo
Obtenha o seu limite atual de créditos.
"limit": 4500,
"error": 0
}
Perguntas frequentes
Como autentico os pedidos à API?
Inclua a sua chave de API secreta como parâmetro apikey no corpo POST de cada pedido. Encontra e gere a chave nas definições do painel.
Quantos URL pode ter um projeto na API?
Até 50.000 URL por projeto, o mesmo limite do painel. Separe-os com uma barra vertical no parâmetro urls ao criar o projeto.
Quanto custa uma verificação pela API?
1 crédito por URL verificado, incluindo a nova verificação no segundo centro de dados. Os créditos nunca expiram e o acesso à API está incluído em todos os planos, a partir do teste gratuito.
Em que formato responde a API?
Em JSON. Cada endpoint devolve um campo error, que é 0 em caso de sucesso, juntamente com os dados do projeto: estado, estatísticas e resultado de indexação por URL quando aplicável.
O IndexChecker é um verificador de indexação em massa no Google operado pela AP2Media Sp. z o.o., uma empresa registada na UE com sede em Czerwin, Polónia (NIF de IVA PL7582396091). É usado em produção nos próprios projetos de SEO da empresa, incluindo o serviço de SEO local drukujemy3d.pl, e verificou mais de dois milhões de URL para os seus clientes nos últimos 30 dias.
A documentação oficial do Google sobre como funciona a indexação e como verificá-la.