Guia de integração
Conecte o seu código à API REST da Rank Prompt
Leve a visibilidade em IA para os seus próprios painéis e pipelines, ou rode relatórios a partir do seu backend, com uma chave com escopo e uma API /v1 versionada e documentada em OpenAPI 3.1.
A Rank Prompt lê
- As suas solicitações
- A chave e os escopos dela
A Rank Prompt envia
- JSON de marcas, relatórios e citações
- Headers de cota
- Erros estruturados
Rank Prompt O que faz
- Gerencia marcas, prompts, relatórios, agendamentos, citações, conteúdo e dados de SEO a partir do seu backend.
- Limita cada chave aos recursos de que precisa e, se quiser, a uma única marca.
- Deixa as escritas seguras para repetir com um
Idempotency-Key, e roda qualquer chamada como prévia grátis com?dry_run=true. - Publica uma spec OpenAPI 3.1 legível por máquina, com uma página de referência para cada endpoint.
Antes de começar
Plano Todos os planos, inclusive o grátis
- Um backend ou script que possa guardar um segredo. Chamadas do navegador são bloqueadas: a API é de servidor para servidor.
- Uma chave de API em Desenvolvedores, Chaves de API, mostrada uma única vez ao ser criada.
- Qualquer plano serve, inclusive o grátis, com 1.000 solicitações por mês no Free.
API REST: configuração em 4 passos
-
Passo 1
Crie uma chave
Na Rank Prompt, abra Desenvolvedores, Chaves de API e clique em Criar chave.
-
Passo 2
Escolha escopos, marca e expiração
Dê um nome que você reconheça, o menor conjunto de escopos de que a integração precisa, uma marca se ela só deve acessar uma, e uma data de expiração para chaves entregues a terceiros.
-
Passo 3
Guarde a chave com segurança
A chave completa, que começa com
rp_live_, aparece uma única vez. Guarde no seu gerenciador de segredos, nunca em código do lado do cliente. -
Passo 4
Faça a primeira chamada
Chame
GET https://api.rankprompt.com/v1/mecomAuthorization: Bearere a sua chave. Isso confirma que a chave funciona e em qual conta ela atua.
API REST: erros e soluções
Estas são as mensagens que o app mostra, palavra por palavra, e o que resolve cada uma.
-
invalid_api_key: API key is invalid or revoked
Confira se copiou a chave inteira, começando por
rp_live_, e se ela não foi revogada em Desenvolvedores. -
insufficient_scope: API key does not have the required scope
O
details.required_scopedo erro diz qual escopo adicionar. Crie uma chave que o inclua. -
brand_not_authorized: API key is not authorized for this brand
A chave está restrita a outra marca. Use uma chave desta marca, ou uma sem restrição de marca.
-
request_quota_exceeded: Monthly request quota exceeded
As solicitações mensais do plano acabaram. Elas renovam com o período de cobrança; os headers de cota de cada resposta mostram quanto resta.
-
browser_calls_forbidden: The Public Developer API is server-to-server only. Browser CORS calls are blocked; call /v1 from your backend with a bearer API key.
Mova a chamada para o seu backend e guarde a chave lá.
A API está incluída no meu plano?
Sim, em todos os planos, inclusive o grátis. O plano define as solicitações mensais, a partir de 1.000 no Free, e as chamadas que fazem trabalho de IA usam os créditos do plano.
Onde fica a referência da API?
Em rankprompt.com/docs/v1, gerada a partir da mesma spec OpenAPI 3.1 que a API serve, com cada endpoint, escopo, código de erro e custo em créditos.
Uma chave pode acessar só a marca de um cliente?
Sim. Restrinja a uma marca ao criá-la, e qualquer solicitação para outra marca responde brand_not_authorized, sejam quais forem os escopos da chave.
E as chaves criadas em uma conta de equipe?
Uma chave atua na conta que estava ativa quando foi criada. GET /v1/me mostra account_id, account_role e account_plan, e a chave para de funcionar se você sair dessa conta.
Funcionando em poucos minutos
Crie uma conta grátis, siga os passos acima e veja o que a conexão soma à sua visibilidade em IA.