Criar endpoints de API REST externa no Dotnetnuke (DNN)
Visão geral
O plugin DNN REST API permite a integração perfeita de APIs externas a sites DNN, o que permite operações de busca e atualização de dados externos por meio de chamadas de API. Este plugin permite recuperar ou atualizar dados externos durante diversos eventos ou operações DNN, como login e registro de usuários, etc. Este guia fornecerá um processo passo a passo para configurar uma API REST externa para sites DNN.
Pré-requisitos: Download e instalação
- Para configurar APIs externas para DNN REST API, você precisará instalar o Plugin de autenticação miniOrange DNN REST API da loja DNN.
- Faça upload do pacote de instalação acessando Configurações > Extensão > Instalar extensão.
Etapas de configuração
Guia passo a passo para autenticação de API externa DNN.
1. Adicionar módulo na página DNN
- Abra qualquer página do seu site DNN (modo de edição) e clique em Adicionar módulo.
- Procurar por API REST DNN e clique em DNN REST API. Arraste e solte o módulo na página desejada.
- Você concluiu a instalação do módulo DNN REST API no seu site DNN.
2. Crie APIs externas
- Navegue até a Configurações da API REST DNN Aba. Aqui, você verá a Painel do plugin DNN REST API.
- Clique em Criar API, para iniciar a geração de API externa.
- Agora selecione API externa.
- Digite os seguintes detalhes:
- Nome da API: Forneça um nome exclusivo para sua API.
- Método API: Selecionar método de solicitação HTTP da lista suspensa.
- Ponto de extremidade da API externa: Configure seu endpoint de API externo.
- Você pode configurar o método de autenticação para a API na guia de autorização e adicionar cabeçalhos, se necessário, na guia Cabeçalhos.
- Você também pode passar os dados no corpo em diferentes formatos, incluindo JSON, x-www-form-urlencoded, xml etc. na aba Corpo.
- Na seção de configurações avançadas, você tem a opção de passar os parâmetros.
- Após inserir os detalhes, clique em Gerar API.
- Agora, na seção APIs externas, você pode encontrar sua API gerada.
3. Teste APIs externas
- Para testar a API, clique em Testar opção sob o Ação suspenso.
- Um pop-up de teste aparecerá. Forneça os detalhes necessários, como cabeçalhos ou dados do corpo, e clique em Execute botão.
- Se tudo estiver configurado corretamente, uma resposta de sucesso será retornada pela API, confirmando que sua API externa está configurada corretamente.
Este guia permitirá que você configure e integre suas APIs externas ao seu aplicativo DNN. Ao utilizar esta integração de API REST com o DNN, você pode realizar operações de busca, inserção, atualização e exclusão de dados externos com segurança por meio de chamadas de API do seu aplicativo DNN.
