RRaiz do Conhecimento

Roteiro 050 · Base de conhecimento

API do Sistema Pacto: o que existe, endpoints e como integrar

Conhecimento escrito · texto para revisão

O que é

Sim, o Sistema Pacto tem uma API REST para integração com sistemas externos, como o site da academia, painéis de gestão e automações. Por ela é possível consultar e registrar dados do módulo ADM, como alunos, contratos e acessos, usando uma credencial (Secret_Key) gerada pela própria academia.

A documentação técnica, com a lista de endpoints, parâmetros e exemplos, é pública e fica no portal de documentação da API: https://api-docs.pactosolucoes.com.br/. Há também uma coleção publicada no Postman: https://documenter.getpostman.com/view/8168625/2sAXjF7ubY. Se um recurso não aparece na documentação, é porque ele não está disponível na API.

Permissão necessária

É necessário ter a permissão “Configurações Empresa” habilitada no perfil de acesso para gerar a credencial.

Como fazer

Gerando a credencial de acesso

  1. No menu lateral, clique na Engrenagem e depois em Integrações;
  2. Se a empresa tiver mais de uma unidade, selecione a unidade. Cada unidade precisa da própria credencial;
  3. Clique no módulo ADM e em API Sistema Pacto;
  4. Na guia Configuração, clique em Gerar credencial;
  5. Informe a Descrição e a Data de validade. Em Definir Escopos de Acesso, mantenha Permitir todas as operações ou escolha os módulos que a integração poderá usar;
  6. Clique em Gerar credencial, copie a Secret_Key e guarde em local seguro. Ela não pode ser visualizada de novo depois de clicar em Concluir.

Observação: a guia Histórico mostra as requisições feitas com a credencial, útil para depurar a integração.

Consultando os endpoints

  1. Acesse o portal de documentação e faça login;
  2. Localize o recurso desejado (alunos, contratos, acessos, treinos) e confira o caminho, o método e os parâmetros;
  3. Autentique as chamadas com a Secret_Key da unidade, conforme a seção de autenticação da documentação.

O que a API cobre e o que não cobre

Checkout e venda no site: a API não substitui o checkout da Pacto. Para vender planos no site, use os links do Gestão de Vendas Online, que já tratam pagamento, contrato e cadastro. Consulte a documentação para os endpoints de consulta de planos e de clientes.

Acessos de catraca: existem consultas de acessos por aluno, como o endpoint de lista rápida de acessos. Não há endpoint documentado que devolva todos os acessos da unidade em um período [VERIFICAR: parâmetros e limite do endpoint de lista rápida de acessos e se ele retorna data e hora]. Para esse levantamento, use os relatórios Lista de Acessos e Totalizador de Acessos no sistema.

Treinos vencidos, alunos sem treino e renovações: verifique na documentação se o recurso existe para o módulo desejado. Se não constar, não há integração disponível, e a alternativa são os relatórios e BIs do sistema.

Atenção: o suporte orienta sobre a geração da credencial e a documentação. Dúvidas técnicas sobre um endpoint específico devem ser registradas em ticket, informando o caminho testado e o retorno recebido, para análise da equipe técnica.

Saiba mais

Para saber como são gerados os links para o Vendas Online, clique aqui.

Para conhecer o relatório Totalizador de Acessos, clique aqui.

Para saber sobre as integrações do módulo Treino, clique aqui.

Para saber sobre as integrações do módulo CRM, clique aqui.

Para saber como gerar a credencial (Secret_Key) da API do Sistema Pacto, clique aqui.

Briefing de origem
Tema
Integrações · prioridade baixa
Tipo
Complemento de artigo existente
Artigo a complementar
Como gerar Credencial (Secret_Key) para uso da API do Sistema Pacto - Tela nova
Pergunta do cliente
Existe API? Onde está a documentação dos endpoints (checkout, acessos de catraca, treinos, renovações)?
O que falta na base
O único artigo cobre a geração da credencial; falta a documentação pública da API e a lista de endpoints.
Ticket de origem
111659, 106740, 67791

Voltar para os roteiros da base