Marca e integrações > Chaves de API - Documentação Omoplata

As chaves de API permitem que um site externo do clube se comunique com segurança com o Omoplata. Por meio da API de Integração, seu site pode exibir sua grade de horários ao vivo e trazer inscrições de aulas experimentais diretamente para o seu clube -- sem manutenção manual.

Acesse Configurações > Chaves de API para gerenciar suas chaves.

Como funciona

A API de Integração é uma interface servidor a servidor: o backend do seu site chama a API com a chave de API -- nunca diretamente pelo navegador do visitante. Isso mantém a chave secreta no servidor.

Navegador do visitante
      │  (HTML/JS)
      ▼
Site externo do clube (SvelteKit / Nuxt / …)
      │  Authorization: Bearer {api_key}
      ▼
API de Integração do Omoplata  ←→  Banco de dados do clube

Cada chave pertence apenas ao seu clube. Usos típicos:

Opção	Descrição
Exibir sua grade de horários	mostre as aulas e sessões do seu clube ao vivo no seu site.
Formulário de inscrição para aula experimental	crie leads no Omoplata a partir de inscrições enviadas pelo seu site.

Criando uma chave

Crie uma nova chave de API nas configurações. Você dá um nome a ela e marca o que ela pode fazer. A chave em texto plano é exibida apenas uma vez -- logo após você criá-la. Copie-a imediatamente e armazene-a com segurança na configuração do servidor do seu site. Apenas um hash é armazenado internamente; a chave em si não pode ser recuperada novamente depois.

Mantenha as chaves secretas

Nunca exponha uma chave de API no navegador ou em código do lado do cliente. Ela pertence apenas ao backend do seu site. Se uma chave for vazada, revogue-a e crie uma nova.

Permissões

Uma chave só faz o que você permitir ao criá-la. Sem a permissão correspondente, a requisição é recusada -- a marcação é o limite, não uma recomendação.

Permissão	O que a chave pode fazer
Ler alunos e contratos	Ler alunos e seus contratos, inclusive em sincronização contínua. Envolve dados pessoais.
Registrar novos alunos	Criar no Omoplata uma inscrição completa vinda do seu site como aluno.
Ler disponibilidade de aulas experimentais	Buscar os horários de aula experimental disponíveis.
Enviar inscrições de aula experimental (leads)	Criar inscrições de aula experimental como leads e seus passos seguintes (confirmar o horário, convidar amigos).
Ler dados do formulário de registro	Buscar a configuração e o texto do contrato do formulário de inscrição.

O quanto uma chave precisa depende do que o seu site vai fazer:

O que o seu site deve fazer	Permissões necessárias
Grade de horários, planos, FAQs, depoimentos e o formulário de contato	nenhuma -- basta uma chave ativa sem permissão alguma. É o conteúdo que o seu clube já publica de qualquer forma.
Formulário de inscrição para aula experimental	Ler disponibilidade de aulas experimentais e Enviar inscrições de aula experimental (leads)
Inscrição completa online como aluno	Ler dados do formulário de registro e Registrar novos alunos
Sincronizar dados de alunos com outro sistema	Ler alunos e contratos

Não existe chave com acesso total: cada chave tem exatamente as permissões que você deu a ela. Use Editar para mudá-las depois -- a chave em si continua a mesma.

O mínimo possível

Conceda apenas o que a integração realmente precisa. Um formulário de aula experimental não tem por que ler os dados dos seus alunos -- e uma chave vazada não consegue fazer mais do que deveria.

Revogando uma chave

Você pode revogar uma chave a qualquer momento. Depois disso, todas as requisições que usam essa chave são rejeitadas -- crie uma nova chave e atualize a configuração do seu site.

Para um passo a passo completo de como conectar seu site, veja Integre com seu site.