Como gerar Credencial (Secret_Key) para uso da API do Sistema Pacto

O que é

Uma Secret_Key é um código único usado para identificar e autorizar o acesso de aplicações, serviços ou usuários a uma API específica. Essa chave serve como uma credencial para permitir interações com a API, auxiliando no controle de acesso e segurança. Veja a documentação técnica com todos os endpoints disponíveis, clicando aqui. Neste conhecimento ensino como gerar o Secret_Key da API do Sistema Pacto.

Permissão necessária

É necessário ter a permissão “Configurações Empresa” habilitada no perfil de acesso do módulo Treino.

Como fazer

1. No menu lateral do sistema clique em “Engrenagem”;

2. Em seguida clique em “Integrações“;

3. Selecione a empresa e clique em “Avançar“; Observação: este campo só apresenta para selecionar as unidades, quando a empresa possui no mesmo banco de dados mais de uma unidade configurada. Atenção: quando uma empresa possui múltiplas unidades e deseja utilizar à API em todas elas, é necessário criar uma Secret_Key separada para cada unidade. Isso ocorre porque a utilização da API é individual para cada unidade, garantindo um controle de acesso específico dos recursos da API em cada unidade.

4. Será apresentada a tela de Integrações de todos os módulos do sistema Pacto. Clique no módulo ADM apresentado na tela;

5. Após localize e clique em "API Sistema Pacto";

6. Na tela será aberto a guia "Configuração", onde será apresentado as credenciais já geradas caso tenha. Para gerar a credencial clique em "Gerar credencial";

7. Na janela "Gerar credencial de produção para uso da API" preencha o campo de "Descrição" e "Data de validade" após clique em "Gerar credencial"; Atenção: após gerada a credencial, não há como excluir apenas inativa-lá inserindo uma data anterior a data atual. Por exemplo: estou no dia 06/06/2024, para inativar insiro a data do dia 05/06/2024.

• Descrição: neste campo deve informar o nome que terá a API nomeie como desejar; Por exemplo: API sistema Pacto. Atenção: este campo é obrigatório.
• Data de validade: neste campo deve definir a validade do "Secret_Key". Por exemplo: estou no dia 06/06/2024 e quero que o "Secret_Key" tenha dois anos de validade, sendo assim defino no campo a data de 06/06/2026. Atenção: após passar o prazo de validade o Secret Key, ficará inativo e a integração deixará de funcionar sendo necessário aumentar o prazo de validade ou criar uma nova integração. 

8. Após gerado a credencial selecione a "Secret_Key" ou clique no ícone

para copiar; Atenção: geramos a credencial com sucesso, fique ciente que não será possível visualizar a "Secret_Key" gerada novamente, então orientamos que a copie agora e guarde ou efetue a geração de uma nova credencial futuramente.

9. Já copiado e salvo  "Secret_Key", clique em "Concluir"; Atenção: reforçamos que salve a chave de segurança antes de concluir, uma vez finalizado o processo não será possível copiar ou visualizar novamente.

10. Pronto, API criada. Observação: para acompanhar a situação das requisições basta clicar em "Histórico".

Saiba mais

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