API Empresarial

API EMPRESARIAL

É um conjunto de padrões que fazem parte de uma interface. Ou seja, é um agrupamento de normas que possibilita a comunicação entre plataformas por meio de uma série de padrões e protocolos.

As APIs são como portas, fornecem acesso a informações e funcionalidades para outros sistemas e aplicativos e agregam valor a um negócio, pois permitem monetizar ativos de informação e possibilitam a inovação ao fornecer acesso a novos recursos.

API – Instalação e Configuração

Atenção: Se não usar o sistema Gestão Empresarial, solicitar o executável com o desenvolvimento.

Obtendo o instalador da API através do Gestão Empresarial:

1. Atualização do Empresarial: Ao executar o atualizador do Empresarial, selecione a opção da API Empresarial marcando o checkbox correspondente.

2. Localização da Pasta: Após concluir o atualizador, navegue até a pasta
`C:\nQuestorEmp`.

Caso já possua o instalador da API de forma separada, pode seguir os passos abaixo:

3. Execução do Instalador: Encontre e execute o arquivo `ApiEmpresarial.exe`.

4. Instalação Padrão: Siga o processo de instalação padrão e instale todas as dependências solicitadas.

5. Execução da API: Inicie a API usando o atalho criado na área de trabalho ou através do menu Iniciar. Se a instalação ocorreu de forma adequada, você verá a seguinte tela:

Caso aparece erro de framework, baixe e instale as 2 dependências abaixo:

https://dotnet.microsoft.com/pt-br/download/dotnet/thank-you/sdk-5.0.408-windows-x64-insta
ller

https://dotnet.microsoft.com/pt-br/download/dotnet/thank-you/sdk-6.0.413-windows-x64-insta
ller

6. Configuração do Banco de Dados: Ajuste os parâmetros de conexão com o banco de dados e valide a conexão.

Instalação do Certificado

Para que a API funcione em uma porta HTTPS de forma segura, é necessário instalar um certificado digital. Siga os passos abaixo:

1. Pressione `Windows+R` e digite “mmc” para abrir o “Gerenciador de Console da Microsoft”.

2. Se não existir uma pasta chamada “Certificados”, vá em `Arquivo -> Adicionar/Remover Snap-in`, clique em `Certificados` e depois em `Adicionar`. Escolha “Conta de Computador” -> “Avançar” -> “Computador local” e pressione `OK`.

3. Navegue até a pasta “Pessoal”, clique com o botão direito do mouse -> `Todas as tarefas` -> `Importar`.

4. Selecione o certificado assinado pela CA e complete o processo de importação através do assistente de Importação de Certificados.

Execução da API

Com a API e os certificados instalados, você pode executar a API seguindo esses passos:

1. Abra a API Empresarial pelo atalho criado ou pelo menu Iniciar.

2. Pressione o botão verde “Executar”.

3. A API abrirá uma página Web para verificação da documentação e aguardará a escolha do certificado em uma janela do Windows.

Se um certificado válido for escolhido, a API rodará em `https://localhost:443` ou `https://localhost`.
Se o certificado não for selecionado, a API rodará em `http://localhost:8080`.

Logs

Os logs de erros da API Empresarial, se houver, podem ser encontrados dentro da pasta onde a API foi instalada, em um arquivo chamado `log.txt`.