Omoplata - Documentação

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. 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.

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.