Uma chave de API permite que o seu próprio código, um script ou uma ferramenta como Zapier atue na sua conta Kadens. Você a cria no painel, escolhe exatamente o que ela pode fazer, e a envia em cada requisição.
Uma chave é um segredo que pertence a uma conta. Toda requisição feita com ela age como essa conta e só pode fazer o que as permissões da chave permitirem.
Toda chave começa com kad_ seguido de 43 caracteres aleatórios. O prefixo torna uma chave fácil de identificar caso acabe em algum lugar onde não deveria estar.
Claude e ChatGPT não precisam de uma chave: eles se conectam entrando pela página de assistentes de IA. Use uma chave para scripts, ferramentas de automação e qualquer outra coisa que envie um cabeçalho.
Envie a chave no cabeçalho Authorization de cada requisição, como um Bearer token.
Authorization: Bearer kad_...Mantenha a chave fora do seu código: guarde-a em uma variável de ambiente como KADENS_API_KEY. Todos os exemplos nesta documentação a leem de lá.
A forma mais rápida de verificar se uma chave funciona: pergunte à API a quem ela pertence.
{
"entity": {
"id": "6f1c2d3e-4b5a-4c7d-8e9f-0a1b2c3d4e5f",
"name": "Barcelona Salsa Studio"
},
"apiKeyId": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"scopes": [
"webhooks.read",
"webhooks.write"
]
}Uma permissão controla uma ação específica da API. Uma chave só pode fazer o que as suas permissões permitirem, então dê a cada chave o menor número de permissões possível. Uma permissão de escrita nunca inclui a permissão de leitura correspondente.
| Permissão | Descrição |
|---|---|
site.read | Ler o conteúdo do siteVer as páginas, blocos e configurações dos seus sites. |
site.design_reference.submit | Enviar referências de designEnviar capturas e layouts para o construtor de sites usar como guia de estilo. |
site.generate | Gerar rascunhos do siteCriar novas páginas e blocos em rascunho com o construtor de sites com IA.Apenas chave de API |
site.compose | Compor o layout do siteAdicionar, reordenar e remover blocos de um rascunho. |
site.theme.configure | Configurar o tema do siteAlterar as cores, fontes e espaçamentos que estilizam um rascunho.Apenas chave de API |
site.preview.read | Ver pré-visualizações do siteAbrir a pré-visualização de um rascunho antes de ele ir ao ar. |
site.publish | Publicar sitesColocar um rascunho no ar no seu site público. |
embed.read | Ver widgets incorporadosVer os seus widgets incorporáveis, as estatísticas, os sites onde foram vistos e os domínios autorizados a mostrá-los. |
embed.write | Gerir widgets incorporadosCriar, editar e arquivar widgets incorporáveis, e adicionar ou remover os domínios autorizados a mostrá-los. |
| Permissão | Descrição |
|---|---|
catalog.read | Ler o seu catálogoConsultar os seus cursos, as suas edições e os planos e preços com que os vende. |
catalog.course.write | Criar cursosAdicionar um curso ao seu catálogo, com o título, o resumo e as lições. |
catalog.plan.write | Definir preços de planosCriar ou alterar os preços de um plano de subscrição que lhe pertence. |
media.import | Importar conteúdoTrazer um vídeo a partir de um URL público para a sua biblioteca de conteúdo. |
schedule.write | Definir a sua disponibilidadeCriar ou substituir o horário semanal a partir do qual as reservas são oferecidas. |
events.read | Ler eventosConsulte os seus eventos, as suas sessões e os tipos de bilhete. |
events.write | Gerir eventosCrie e altere os seus eventos, as suas sessões e os tipos de bilhete. |
schedule.read | Ler a programaçãoConsulte a programação das suas aulas, as suas sessões e os calendários que publica. |
schedule.manage | Gerir a programaçãoCriar, alterar e cancelar as aulas, as sessões e os calendários publicados da sua programação. |
| Permissão | Descrição |
|---|---|
orders.read | Ler encomendasConsulte as suas encomendas, pagamentos e reembolsos. |
subscriptions.read | Ler assinaturasConsulte as assinaturas dos seus planos e o seu estado. |
bookings.read | Ler reservasConsulte as reservas das suas aulas e sessões. |
payouts.read | Ler pagamentos recebidosConsulte os pagamentos que recebe e o seu saldo. |
pricing.write | Gerir preços e descontosCrie e altere descontos, extras, ofertas e as regras que decidem quem pode comprar o quê. |
orders.write | Gerir encomendas e reembolsosAltere encomendas e emita reembolsos. Um reembolso devolve dinheiro ao comprador. |
payments.write | Gerir pagamentosAltere as definições de pagamento, as carteiras e a cobrança da sua conta. Pode movimentar dinheiro. |
insights.read | Ler estatísticasConsulte as suas estatísticas e os números do seu painel. |
| Permissão | Descrição |
|---|---|
attendees.read | Ler participantesConsulte quem tem bilhetes para os seus eventos e as suas entradas. |
enrollments.read | Ler inscriçõesConsulte quem está inscrito nos seus cursos e o seu progresso. |
people.read | Ler dados pessoaisAceda aos nomes, endereços de email e outros dados pessoais dos seus clientes. Sem esta permissão ficam ocultos. |
people.write | Gerir clientesAdicione e altere as pessoas do seu CRM, os seus acessos e os seus pedidos. |
attendees.write | Registar participantesRegiste a entrada e a saída dos participantes nos seus eventos e sessões. |
| Permissão | Descrição |
|---|---|
webhooks.read | Ver webhooksVer os seus endpoints de webhook, o registo de entregas e o catálogo de eventos. |
webhooks.write | Gerir webhooksCriar, editar e remover endpoints de webhook, rodar os seus segredos e enviar, reenviar ou repetir eventos. |
| Permissão | Descrição |
|---|---|
permissions.policy.read | Ler políticas de permissãoVer o que cada função pode fazer em todo o seu perfil. |
permissions.policy.write | Alterar políticas de permissãoConceder e retirar o que cada função pode fazer em todo o seu perfil.Apenas chave de API |
actions.delegate | Agir em seu nomePermite que o assistente execute em seu nome qualquer ação que você possa fazer no Kadens, dentro das outras permissões que você conceder. |
| Permissão | Descrição |
|---|---|
learning.read | Ler a aprendizagemConsulte exames, notas, certificados, práticas entregues e o progresso dos alunos. |
learning.write | Gerir a aprendizagemCorrija exames, publique resultados, emita certificados e reveja as práticas entregues. |
| Permissão | Descrição |
|---|---|
community.read | Ler a comunidadeConsulte a sua comunidade, anúncios, conversas, avaliações e perguntas frequentes. |
community.write | Gerir a comunidadePublique anúncios, responda a conversas e modere a sua comunidade, avaliações e perguntas frequentes. |
| Permissão | Descrição |
|---|---|
marketing.read | Ler marketingConsulte os seus envios de email, lembretes, afiliados e recompensas. |
marketing.write | Gerir marketingCrie e envie emails, configure lembretes e gira afiliados e recompensas. |
| Permissão | Descrição |
|---|---|
terms.read | Ler as condições da sua contaConsultar a comissão, os limites e o período experimental acordados para a sua conta. |
settings.read | Ler definiçõesConsulte o seu perfil, etiquetas, integrações e definições da conta. |
settings.write | Alterar definiçõesAltere o seu perfil, etiquetas, integrações e definições da conta. |
| Tópico | Descrição |
|---|---|
Reemitir | Cria uma nova chave com o mesmo nome, permissões e prazo de expiração. A chave antiga para de funcionar imediatamente, então atualize-a em todos os lugares onde é usada. |
Revogar | Desativa a chave imediatamente. Qualquer integração que a use para de funcionar. Isso não pode ser desfeito. |
Expiração | Uma chave criada com uma expiração para de funcionar nessa data. Uma chave sem expiração funciona até você revogá-la. |
Último uso | O painel mostra quando cada chave foi usada pela última vez. Uma chave que ninguém usa há muito tempo é uma boa candidata a revogar. |
O código de status diz à sua integração o que fazer em seguida.
| Status | Significado |
|---|---|
401 | A chave está ausente, mal formatada, revogada ou expirada. Verifique o cabeçalho Authorization, ou crie uma nova chave. |
403 | A chave funciona, mas não tem a permissão que esta requisição precisa. Reemitir mantém as mesmas permissões, então crie uma chave com a permissão que falta. |
{
"statusCode": 403,
"message": "API key missing required scope",
"timestamp": "2026-10-01T10:00:00.000Z",
"path": "/api/v1/me",
"requestId": "req_7c1e0b"
}Isso ajudou?