API REST · v1.0

Integre seu sistema ao RankWise

Automatize geração de conteúdo SEO com IA, pesquisa de keywords e auditoria técnica do seu site. Use tokens Bearer pra autenticar e chame endpoints REST de qualquer linguagem.

Começar em 3 passos Como gerar token

Base URL https://api.rankwiseai.com.br/api

Endpoints documentados 150

Formato JSON · REST

Comece agora

3 passos pra fazer sua primeira chamada autenticada. Em menos de 5 minutos.

Crie uma conta no RankWise

Faça cadastro em app.rankwiseai.com.br. O e-mail e senha cadastrados servem pra obter o token via API.

Gere um token Bearer

Chame POST /api/auth/login com seu e-mail e senha. A resposta inclui o token Sanctum a ser usado em chamadas posteriores.

curl -X POST https://api.rankwiseai.com.br/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "voce@empresa.com.br", "password": "sua-senha"}'

const res = await fetch('https://api.rankwiseai.com.br/api/auth/login', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ email: 'voce@empresa.com.br', password: 'sua-senha' }),
})
const { token } = await res.json()

import requests

res = requests.post(
    "https://api.rankwiseai.com.br/api/auth/login",
    json={"email": "voce@empresa.com.br", "password": "sua-senha"},
)
token = res.json()["token"]

Faça sua primeira chamada autenticada

Use o token no header Authorization: Bearer {token}. Exemplo: listar seus projetos.

curl https://api.rankwiseai.com.br/api/projects \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Accept: application/json"

const res = await fetch('https://api.rankwiseai.com.br/api/projects', {
  headers: {
    'Authorization': `Bearer ${token}`,
    'Accept': 'application/json',
  },
})
const projects = await res.json()

res = requests.get(
    "https://api.rankwiseai.com.br/api/projects",
    headers={"Authorization": f"Bearer {token}"},
)
projects = res.json()

Autenticação

Todos os endpoints marcados como Protegido exigem token Bearer no header Authorization. Tokens são gerados via POST /api/auth/login e não expiram automaticamente — revogue manualmente quando necessário via POST /api/auth/logout.

Onde obter: o token é gerado em resposta ao login com seu e-mail e senha de cliente RankWise. Para revogá-lo, use POST /api/auth/logout ou crie um novo (o anterior continua válido até ser revogado).

Header obrigatório em chamadas protegidas:

Authorization: Bearer SEU_TOKEN_AQUI
Accept: application/json
Content-Type: application/json

Base URL e ambientes

Por enquanto há apenas o ambiente de produção. Sandbox dedicado em planejamento.

Ambiente	URL
Produção	`https://api.rankwiseai.com.br/api`

Códigos de erro

Respostas seguem padrão HTTP. Erros retornam JSON com message e, quando aplicável, errors com detalhes por campo.

Código	Significado
`200/201`	Sucesso. Resposta contém o recurso.
`401`	Não autenticado — token ausente, inválido ou revogado.
`402`	Pagamento necessário — assinatura inativa ou recurso premium.
`403`	Permissão insuficiente para o recurso solicitado.
`404`	Recurso não encontrado.
`422`	Validação falhou — payload retornado contém `errors` por campo.
`429`	Rate limit excedido. Aguarde antes de re-tentar.
`5xx`	Erro do servidor. Tente novamente em alguns segundos; se persistir, contate o suporte.

Rate limit

Endpoints públicos têm limite por IP. Endpoints autenticados têm limite por token. Exceder retorna 429 com header Retry-After em segundos.

Recomendação: implemente retry com exponential backoff (1s → 2s → 4s → 8s) para erros 429 e 5xx. Não rode em loop apertado.

Autenticação

POST /api/auth/change-password Protegido

POST /api/auth/forgot-password Público

GET /api/auth/google/callback Público

GET /api/auth/google/start Público

POST /api/auth/login Público

POST /api/auth/logout Protegido

GET /api/auth/me Protegido

PATCH /api/auth/me Protegido

POST /api/auth/register Público

POST /api/auth/reset-password Público

Planos

Catálogo público dos planos disponíveis.

GET /api/plans Público

Projetos

CRUD dos seus projetos e dos sub-recursos (ICP, Brain de marca, concorrentes).

POST /api/projects Protegido

GET /api/projects Protegido

GET /api/projects/{project} Protegido

PUT /api/projects/{project} Protegido

PATCH /api/projects/{project} Protegido

DELETE /api/projects/{project} Protegido

GET /api/projects/{project}/articles Protegido

POST /api/projects/{project}/articles/generate Protegido

GET /api/projects/{project}/articles/{article} Protegido

PUT /api/projects/{project}/articles/{article} Protegido

DELETE /api/projects/{project}/articles/{article} Protegido

POST /api/projects/{project}/articles/{article}/approve Protegido

POST /api/projects/{project}/articles/{article}/mark-reviewed Protegido

DELETE /api/projects/{project}/articles/{article}/mark-reviewed Protegido

POST /api/projects/{project}/articles/{article}/preview-seo-score Protegido

POST /api/projects/{project}/articles/{article}/publish Protegido

POST /api/projects/{project}/articles/{article}/publish-wix Protegido

POST /api/projects/{project}/articles/{article}/reject Protegido

POST /api/projects/{project}/articles/{article}/retry Protegido

POST /api/projects/{project}/articles/{article}/rewrite Protegido

POST /api/projects/{project}/articles/{article}/schedule Protegido

DELETE /api/projects/{project}/articles/{article}/schedule Protegido

GET /api/projects/{project}/articles/{article}/sections Protegido

POST /api/projects/{project}/articles/{article}/sections/regenerate Protegido

GET /api/projects/{project}/articles/{article}/seo-score Protegido

POST /api/projects/{project}/articles/{article}/social Protegido

POST /api/projects/{project}/articles/{article}/social/all Protegido

POST /api/projects/{project}/articles/{article}/submit-review Protegido

GET /api/projects/{project}/articles/{article}/versions Protegido

GET /api/projects/{project}/backlinks Protegido

POST /api/projects/{project}/backlinks/fetch Protegido

GET /api/projects/{project}/backlinks/opportunities Protegido

GET /api/projects/{project}/backlinks/summary Protegido

GET /api/projects/{project}/brain Protegido

GET /api/projects/{project}/brain/entries Protegido

POST /api/projects/{project}/brain/entries Protegido

PUT /api/projects/{project}/brain/entries/{entry} Protegido

DELETE /api/projects/{project}/brain/entries/{entry} Protegido

POST /api/projects/{project}/brain/refresh Protegido

POST /api/projects/{project}/brain/toggle Protegido

GET /api/projects/{project}/competitors Protegido

POST /api/projects/{project}/competitors/discover Protegido

PUT /api/projects/{project}/competitors/{competitor} Protegido

POST /api/projects/{project}/domain/check Protegido

POST /api/projects/{project}/domain/start Protegido

GET /api/projects/{project}/google-ads/accounts Protegido

POST /api/projects/{project}/google-ads/disconnect Protegido

GET /api/projects/{project}/google-ads/keywords Protegido

POST /api/projects/{project}/google-ads/select-account Protegido

POST /api/projects/{project}/gsc/disconnect Protegido

POST /api/projects/{project}/gsc/select-site Protegido

GET /api/projects/{project}/gsc/sites Protegido

GET /api/projects/{project}/icp Protegido

PUT /api/projects/{project}/icp Protegido

DELETE /api/projects/{project}/icp Protegido

GET /api/projects/{project}/icp/alignment Protegido

POST /api/projects/{project}/icp/suggest Protegido

GET /api/projects/{project}/keywords Protegido

POST /api/projects/{project}/keywords Protegido

POST /api/projects/{project}/keywords/approve Protegido

POST /api/projects/{project}/keywords/bulk Protegido

POST /api/projects/{project}/keywords/bulk-delete Protegido

POST /api/projects/{project}/keywords/cluster Protegido

POST /api/projects/{project}/keywords/people-also-ask Protegido

POST /api/projects/{project}/keywords/refresh Protegido

POST /api/projects/{project}/keywords/research Protegido

PUT /api/projects/{project}/keywords/{keyword} Protegido

DELETE /api/projects/{project}/keywords/{keyword} Protegido

POST /api/projects/{project}/keywords/{keyword}/approve Protegido

GET /api/projects/{project}/keywords/{keyword}/history Protegido

GET /api/projects/{project}/lead-form Protegido

PUT /api/projects/{project}/lead-form Protegido

POST /api/projects/{project}/lead-form/generate-copy Protegido

DELETE /api/projects/{project}/leads Protegido

POST /api/projects/{project}/onboarding/apply Protegido

POST /api/projects/{project}/onboarding/start Protegido

GET /api/projects/{project}/onboarding/status Protegido

GET /api/projects/{project}/search-console Protegido

POST /api/projects/{project}/search-console/fetch Protegido

POST /api/projects/{project}/seo/audit/article/{article} Protegido

POST /api/projects/{project}/seo/audit/url Protegido

GET /api/projects/{project}/seo/audits Protegido

GET /api/projects/{project}/seo/cannibalization Protegido

POST /api/projects/{project}/seo/cannibalization/detect Protegido

GET /api/projects/{project}/social Protegido

PUT /api/projects/{project}/social/{socialPost} Protegido

GET /api/projects/{project}/webhooks Protegido

POST /api/projects/{project}/webhooks Protegido

PATCH /api/projects/{project}/webhooks/{webhook} Protegido

DELETE /api/projects/{project}/webhooks/{webhook} Protegido

POST /api/projects/{project}/webhooks/{webhook}/test Protegido

POST /api/projects/{project}/wix/connection Protegido

POST /api/projects/{project}/wix/test Protegido

POST /api/projects/{project}/wordpress/connection Protegido

POST /api/projects/{project}/wordpress/test Protegido

POST /api/projects/{project}/wordpress/update-plugin Protegido

POST /api/projects/{project}/youtube Protegido

GET /api/projects/{project}/youtube Protegido

POST /api/projects/{project}/youtube/{youtubeSource}/generate Protegido

POST /api/projects/{project}/youtube/{youtubeSource}/transcribe Protegido

Artigos

Geração com IA, edição, agendamento, publicação e versões.

POST /api/articles/extract-pdf Protegido

Faturamento

Métodos de pagamento, assinatura atual e faturas.

POST /api/billing/cancel Protegido

POST /api/billing/extra-project Protegido

GET /api/billing/methods Público

GET /api/billing/project-usage Protegido

POST /api/billing/start-trial Protegido

POST /api/billing/subscribe Protegido

GET /api/billing/subscription Protegido

POST /api/billing/update-card Protegido

Métricas

Performance via Google Search Console (cliques, impressões, CTR, posição).

GET /api/metrics/gsc-summary Protegido

Notificações

Lista de notificações in-app e marcação como lidas.

GET /api/notifications Protegido

POST /api/notifications/mark-all-read Protegido

GET /api/notifications/unread-count Protegido

DELETE /api/notifications/{id} Protegido

POST /api/notifications/{id}/read Protegido

Integrações

WordPress (publicação direta), Wix Velo (HTTP Function) e webhooks de saída.

POST /api/integrations/google-ads/start Protegido

GET /api/integrations/google/callback Público

POST /api/integrations/google/start Protegido

Plugin WordPress

Download oficial do plugin RankWise Connector (WordPress).

GET /api/wp-plugin/download Público

POST /api/wp-plugin/seo-config Público

GET /api/wp-plugin/version Público

Sitemap

GET /api/sitemap/{token}.xml Público

Referral

POST /api/referral/validate Público

Leads

GET /api/leads Protegido

POST /api/leads/capture Público

GET /api/leads/export Protegido

POST /api/leads/form-config Público

GET /api/leads/metrics Protegido

POST /api/leads/track-view Público

DELETE /api/leads/{lead} Protegido

Content

GET /api/content Público

GET /api/content/{key} Público

Uploads

POST /api/uploads/image Protegido

DELETE /api/uploads/image Protegido

Api Tokens

GET /api/api-tokens Protegido

POST /api/api-tokens Protegido

DELETE /api/api-tokens/{id} Protegido

Calendar

GET /api/calendar/scheduled Protegido

Ai

GET /api/ai/models Protegido

Suporte

Dúvidas sobre integração, novos endpoints ou problemas técnicos? Entre em contato: