1. Verificação da instalação do IIS no Windows
Antes de iniciar a instalação da API Metadados, é necessário validar se o IIS - Internet Information Services já está instalado no Windows.
Para verificar, pressione as teclas abaixo:
Será aberta a seguinte janela:
No campo exibido, digite:
inetmgr
Em seguida, clique em OK.
Caso o IIS já esteja instalado, a console do IIS será aberta normalmente.
Se o IIS não estiver instalado, será exibido um erro ou aviso informando que o comando não foi encontrado. Nesse caso, siga o procedimento abaixo para instalar o recurso.
2. Instalação do IIS
A instalação pode ser realizada via PowerShell ou Prompt de Comando (CMD), sempre executando a ferramenta como Administrador.
2.1 Instalação via PowerShell
Abra o PowerShell como Administrador e execute:
Enable-WindowsOptionalFeature -Online -FeatureName IIS-WebServerRole -All
2.2 Instalação via CMD
Abra o Prompt de Comando como Administrador e execute:
DISM /Online /Enable-Feature /FeatureName:IIS-WebServerRole /All
Após a instalação, valide novamente se o IIS foi instalado corretamente.
Pressione as teclas:
Será aberta a seguinte janela:
Digite:
inetmgr
Depois clique em OK.
Se a instalação estiver correta, o IIS será aberto.
Após validar a abertura do IIS, ele pode ser minimizado por enquanto.
3. Download dos arquivos necessários
Agora será necessário baixar os requisitos da API Metadados e o instalador da API Metadados.
Acesse o portal do cliente Metadados:
https://cliente.metadados.com.br/login?returnUrl=%2Fdashboard
Após acessar o portal, será exibida a tela abaixo. Clique em Atualização de Produtos.
Depois clique em Arquivos Públicos.
Por fim, baixe o Instalador da API Metadados e os Requisitos.
4. Certificado SSL
Antes de configurar a API Metadados no IIS, é importante destacar que o certificado SSL é obrigatório.
Neste manual, será utilizado um certificado SSL autoassinado apenas para fins demonstrativos. Em ambiente oficial, produtivo ou acessível por clientes, o certificado deve ser emitido por uma certificadora válida.
Exemplos de certificadoras:
- DigiCert
- Sectigo
- GlobalSign
- Entrust
- Let's Encrypt
Existem outras certificadoras disponíveis no mercado, e o cliente pode escolher a que melhor atende às necessidades da organização.
Neste manual será demonstrado apenas o processo de importação de um certificado já existente no formato .PFX para o IIS.
5. Preparação da pasta da API Metadados
Agora será preparada a pasta onde ficarão os arquivos da API Metadados.
Abra o Explorador de Arquivos do Windows.
Clique em Este Computador.
Selecione o Disco Local (C:).
Dentro do disco C:, acesse a pasta:
inetpub
Depois acesse a pasta:
wwwroot
Dentro da pasta wwwroot, crie uma nova pasta chamada:
ApiMetadados
Após criar a pasta, minimize o Explorador de Arquivos. O próximo passo será realizado no IIS.
6. Importação do certificado SSL no IIS
Na tela inicial do IIS, clique duas vezes em Certificados de Servidor.
Na tela carregada, clique com o botão direito do mouse e selecione a opção Importar.
Será aberta a seguinte tela. Clique no botão de seleção localizado no canto direito para informar o caminho do certificado SSL.
Selecione o certificado SSL que será importado e clique em Abrir.
Após selecionar o arquivo, ele ficará visível na tela de importação.
Informe a senha do certificado SSL no campo Senha e clique em OK.
Pronto. O certificado foi importado para o IIS.
7. Criação do site da API Metadados no IIS
Agora será configurado o site da API Metadados no IIS.
Na lateral esquerda do IIS, clique na pequena seta ao lado do nome do servidor, conforme demonstrado abaixo.
Ao expandir, os seguintes elementos serão exibidos.
Clique com o botão direito do mouse sobre a pasta Sites.
Será exibido o menu de opções.
Clique em Adicionar Site...
Será aberta a janela de configuração do novo site, onde será criada a aplicação da API Metadados.
No campo Nome do site, informe:
ApiMetadados
No campo Caminho físico, selecione a pasta criada anteriormente para a API Metadados.
O caminho base será:
C:\inetpub\wwwroot
Dentro dele, selecione a pasta:
ApiMetadados
Depois clique em OK, conforme demonstrado na imagem abaixo.
Após clicar em OK, o caminho físico será definido no IIS.
Agora, no campo Associação, clique em Tipo.
Selecione a opção:
https
8. Configuração do nome do host
Agora será configurado o campo Nome do Host.
O padrão recomendado é:
apimetadados.seudominio.com.br
Ou seja, após apimetadados., informe o domínio da sua organização.
Exemplos:
apimetadados.empresa.com.br
apimetadados.empresa.com
apimetadados.empresa.ind.br
Para este manual demonstrativo, será utilizado o seguinte nome de host:
apimetadados.teste.com.br
Agora selecione o certificado SSL que foi importado anteriormente, clicando no campo Certificado SSL.
Após preencher todos os campos, desmarque a opção Iniciar site imediatamente e clique em OK.
Depois disso, minimize o IIS.
9. Instalação da API Metadados
Localize o instalador da API Metadados e clique duas vezes sobre ele.
Após executar o instalador, será exibida uma janela de confirmação solicitando permissão para instalar a API Metadados.
Clique em Sim.
Após confirmar, será aberta a janela do instalador da API Metadados.
Clique na seta localizada no canto direito e selecione o site criado anteriormente:
ApiMetadados
Depois clique em Próximo.
Após clicar em Próximo, será aberta a tela abaixo.
Caso o banco de dados da Metadados esteja instalado no mesmo servidor ou máquina onde a API está sendo instalada, ao clicar no campo indicado abaixo, poderá ser exibido o arquivo que contém os dados de conexão com o banco.
Caso a base de dados não esteja instalada na máquina, como no exemplo deste manual, clique em Próximo.
Será aberta a tela de configuração da conexão com o banco de dados.
Se o arquivo de conexão anterior existir, os campos poderão ser preenchidos automaticamente. Caso contrário, eles serão exibidos em branco.
10. Configuração da conexão com o banco de dados
Nesta tela será configurada a comunicação da API Metadados com o banco de dados.
Clique na seta localizada no canto direito para selecionar o tipo de banco utilizado.
As opções disponíveis são:
Oracle
ou
SQL Server
Após selecionar o banco de dados, preencha os campos com as informações de conexão.
Recomenda-se utilizar o valor de 60 segundos para o limite de comunicação, garantindo uma margem adequada para a conexão com o banco.
Depois de preencher os campos, clique em Testar para validar a comunicação.
Se o teste for concluído com sucesso, clique em Próximo.
11. Cadastro do administrador da API
Após clicar em Próximo, poderá ser exibida uma tela solicitando os seguintes dados:
Nome:E-mail:Senha:
Os campos Nome e E-mail devem ser preenchidos com os dados da pessoa responsável pela administração da API Metadados.
Recomenda-se utilizar o responsável de TI do cliente, pois a área administrativa da API exige conhecimentos técnicos que podem não fazer parte da rotina da equipe de RH.
Caso o campo Senha não seja liberado após informar o e-mail, clique em Próximo. Isso indica que o e-mail informado já está cadastrado no ecossistema da Metadados, não sendo necessário informar uma nova senha.
12. Configuração da URL da API
Nesta etapa, informe a URL definida anteriormente no IIS, no campo Nome do Host.
Exemplo utilizado neste manual:
https://apimetadados.teste.com.br
Após preencher a URL, clique em Instalar.
Se todo o processo ocorrer corretamente, será exibida a tela abaixo.
Clique em Concluir.
13. Instalação dos requisitos da API Metadados
Por fim, será necessário instalar os requisitos da API Metadados.
Clique duas vezes no instalador:
dotnet-hosting
Clique em Instalar.
Caso seja solicitada permissão de administrador, autorize a instalação.
Aguarde a conclusão da instalação.
Após a instalação ser concluída, clique em Fechar.
O outro requisito deve ser instalado seguindo o mesmo padrão.
14. Validação final da API Metadados
Após concluir todas as etapas de instalação e configuração, abra o navegador e acesse a URL configurada no IIS.
Exemplo utilizado neste manual:
https://apimetadados.teste.com.br
Se a instalação estiver correta, será exibida a tela da API Metadados.
O responsável de TI deverá acessar utilizando o usuário e senha configurados anteriormente.
Observação importante sobre o Certificado SSL
Importante: Durante a demonstração deste manual, o navegador poderá exibir um aviso informando que a conexão não é segura ou que o certificado não é confiável. Esse comportamento é esperado, pois foi utilizado um certificado SSL autoassinado apenas para fins de demonstração.
Em um ambiente de produção, recomenda-se utilizar um certificado SSL emitido por uma Autoridade Certificadora (CA) reconhecida, como DigiCert, Sectigo, GlobalSign, Entrust, Let's Encrypt ou outra certificadora de confiança. Dessa forma, o navegador reconhecerá automaticamente a autenticidade do certificado, eliminando os avisos de segurança apresentados durante o acesso à API.
Observação importante sobre DNS
Para que a URL funcione corretamente, o domínio configurado no IIS precisa resolver para o servidor onde a API está instalada.
Em ambiente produtivo, isso deve ser feito por meio de um registro DNS.
Exemplo:
apimetadados.empresa.com.br → IP do servidor
Em ambiente local ou demonstrativo, pode ser necessário configurar o arquivo hosts do Windows para apontar o domínio para o próprio servidor.
Exemplo:
127.0.0.1 apimetadados.teste.com.br
Sem essa resolução de DNS, o navegador poderá exibir erro como:
DNS_PROBE_FINISHED_NXDOMAIN