Chaves de API
Use uma chave de API pessoal para chamar a API REST pelos seus scripts.
Criar e revogar uma chave
Entre na NinjaBuy e abra Conta → Indicações → Chaves de API para criar, listar e revogar chaves com nome. A chave completa começa com nb_ e é exibida apenas uma vez. Use Copiar chave para guardá-la com segurança antes de fechar a mensagem.
Uma chave nunca expira, a menos que você escolha uma validade ao criá-la: 30 dias, 90 dias ou 1 ano. A revogação ou o fim dessa validade se aplica à próxima requisição, e uma chave expirada some da lista.
Somente um hash SHA-256 da chave é armazenado.
Usar uma chave
Forneça a chave ao seu script como NINJABUY_API_KEY e envie-a no cabeçalho Authorization:
curl -sS https://www.ninjabuy.com/api/v1/links \
-H "Authorization: Bearer $NINJABUY_API_KEY" \
-H "Content-Type: application/json" \
--data '{"links":["https://weidian.com/item.html?itemID=7581746714"]}'O mesmo cabeçalho funciona em todas as rotas REST autenticadas: Links, Busca, uploads e Planilhas, e Tarefas. O documento OpenAPI não exige autenticação.
Permissões e limites
Todas as chaves recebem as três permissões. Não há seletor de permissões.
| Permissão | Rotas |
|---|---|
links:create | POST /api/v1/links, POST /api/v1/uploads, POST /api/v1/sheets |
jobs:read | GET /api/v1/jobs/{id} |
search:read | GET /api/v1/search |
As chaves e as requisições REST com OAuth compartilham as janelas de criação e busca da conta. A criação de links pelo MCP também compartilha a janela de criação. Veja Limites de requisições.
Uma chave não permite entrar, abrir uma sessão nem chamar o MCP ou as APIs da conta. Use OAuth para um aplicativo que atua por outros clientes da NinjaBuy ou um cliente MCP.
Falhas
Uma chave inválida, expirada ou revogada retorna o mesmo problema 401 de um token OAuth inválido. Uma indisponibilidade do armazenamento de chaves retorna 503 com Retry-After. Veja Erros.