Conecte suas ferramentas com a API
A API permite que um aplicativo de terceiros acesse os dados da sua Organização de forma programática: cadastros, calendários, reservas e faturamento. Ela é ativada em dois cliques e é protegida por uma chave, uma lista de endereços autorizados e um acompanhamento de consumo.
Saiba se a API é para você
A API se destina a um desenvolvedor, não a um responsável de Organização. Ela serve para fazer sua conta dialogar com um software que você manda desenvolver ou configurar: um site sob medida, uma ferramenta de contabilidade, um painel de exibição próprio, uma ponte para outro sistema.
Para as necessidades do dia a dia — obter a lista de Membros, atualizar Assinaturas em massa, enviar números para a diretoria — os módulos de importação, exportação e relatórios atendem sem escrever uma linha de código.
A API é oferecida em versão beta: seu funcionamento ainda pode evoluir.
Ativar a API e obter sua chave
- Acesse Administração›Configurações›API BETA.
- Ative Ativar o módulo API e clique em Salvar.
- Sua Chave API é exibida: copie-a com o botão Copiar e transmita-a apenas à ferramenta que você está conectando.
A chave é transmitida no cabeçalho HTTP X-API-Key de cada requisição. As chamadas são feitas obrigatoriamente em HTTPS; nenhuma requisição não criptografada é aceita.
Proteger a chave
Alguns cuidados merecem ser lembrados à ferramenta ou ao prestador que a utiliza:
- nunca deixar a chave em um repositório de código; armazená-la em um arquivo de configuração fora do repositório ou em um gerenciador de segredos;
- restringir os endereços autorizados assim que a ferramenta fizer chamadas a partir de um servidor fixo;
- gerar uma nova chave à menor dúvida — publicação acidental, vazamento de registros, fim do contrato de um prestador.
O botão Regenerar pede confirmação e, em seguida, invalida a chave anterior imediatamente. Todos os aplicativos que a utilizavam deixam de funcionar enquanto não receberem a nova: avise-os antes de clicar.
Restringir o acesso por endereço IP
Ative a Restrição por endereço IP: apenas as requisições provenientes dos endereços que você listar são aceitas, no limite de 10 endereços IPv4. Digite cada endereço e valide com Adicionar; seu endereço atual é exibido na tela para ajudá-lo.
Essa é a proteção mais eficaz e a mais frequentemente negligenciada: mesmo divulgada, uma chave restrita ao endereço do seu prestador continua inutilizável em outro lugar.
Acompanhar o consumo
A tela exibe continuamente o que sua chave consome:
- Uso neste minuto e Uso hoje, cada uma comparada ao seu limite quando um limite está configurado;
- Estatísticas de uso: Esta semana, Este mês, Total e Última solicitação.
Além dos limites indicados, as requisições adicionais são temporariamente recusadas. Um contador que fica permanentemente próximo do teto geralmente indica uma ferramenta mal ajustada, que solicita os mesmos dados em ciclo em vez de armazená-los em cache.
A data da última requisição é útil no sentido inverso: uma chave ativada mas nunca chamada há meses é uma chave a desativar.
Descobrir o que a API permite
A documentação completa, com os parâmetros e exemplos de chamada, é exibida na parte inferior da tela do módulo. Em linhas gerais:
- Usuários: é o único recurso modificável. Você pode listar, consultar, criar, alterar e excluir contas.
- Configuração: Assinaturas, perfis, grupos e categorias de idade podem ser consultados, mas só são configurados a partir do aplicativo.
- Reserva: calendários, Horários disponíveis, Reservas e Rótulos podem ser consultados.
- Faturamento: Contas de faturamento, Pedidos e pagamentos podem ser consultados.
