Início rápido da API

Este início rápido cobre o essencial: autenticação, geração do seu primeiro relatório e leitura da resposta. A documentação técnica completa, com cada endpoint, está disponível dentro da sua conta.

Introdução

A API do InspectWP permite analisar sites WordPress de forma programática e obter relatórios detalhados sobre plugins, temas, segurança, SEO, desempenho e muito mais.

Formato da resposta

Todas as respostas da API seguem um formato JSON consistente:

Resposta de sucesso

{
  "success": true,
  "data": { ... },
  "meta": { ... }
}

Resposta de erro

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Description",
    "status": 400
  }
}

Autenticação

Todas as requisições à API exigem um token Bearer no cabeçalho Authorization. Os tokens têm o prefixo iwp_ e são válidos por 365 dias.

Crie seu token de API no Painel da API.

Exemplo de cabeçalho

Authorization: Bearer iwp_your_api_token_here

Erros de autenticação

Se o token estiver ausente ou for inválido, a API retorna uma resposta 401 Unauthorized:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API token. Provide a valid Bearer token in the Authorization header.",
    "status": 401
  }
}

Início rápido

Crie um token de API

Acesse o painel da API e crie um novo token.

Faça sua primeira requisição

Use seu token para gerar um relatório de análise WordPress:

curl -X POST https://inspectwp.com/api/generate-report \
  -H "Authorization: Bearer iwp_your_token" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

const response = await fetch('https://inspectwp.com/api/generate-report', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer iwp_your_token',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ url: 'https://example.com' })
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    'https://inspectwp.com/api/generate-report',
    headers={
        'Authorization': 'Bearer iwp_your_token',
        'Content-Type': 'application/json'
    },
    json={'url': 'https://example.com'}
)

data = response.json()
print(data)

$ch = curl_init('https://inspectwp.com/api/generate-report');

curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer iwp_your_token',
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode(['url' => 'https://example.com'])
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

print_r($data);

Obtenha os resultados

A resposta contém o relatório completo de análise com todas as seções.

A geração do relatório pode levar de 20 a 90 segundos, pois o site é analisado em tempo real.

Procurando a referência completa da API com todos os endpoints, códigos de erro e esquemas de resposta? A documentação completa está disponível após você fazer login. Abrir a documentação completa da API.