Crie endpoints de API REST personalizados no Dotnetnuke (DNN)
Visão geral
O plugin DNN REST API permite criar endpoints de API personalizados dentro da plataforma DNN, permitindo que sistemas externos interajam com as funcionalidades da plataforma. Você pode configurar facilmente seus endpoints de API personalizados para atender a requisitos específicos, usando todos os métodos HTTP. Este guia do usuário oferece documentação abrangente para ajudar você a configurar e testar APIs personalizadas.
Pré-requisitos: Download e instalação
- Para configurar APIs personalizadas 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 personalizada do 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 personalizadas
- Navegue até a Guia de configurações da API REST DNN. Aqui, você verá o Painel do plugin de autenticação DNN REST API.
- Clique em Criar API, para iniciar a geração de API personalizada.
- Selecione o tipo de API como API personalizada.
- 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.
- Nome da tabela: Especifique a tabela que você deseja acessar.
- Coluna de Resposta: Selecione as colunas nas quais você deseja executar operações.
- Configurar autenticação (opcional): Na aba Configurações avançadas, você pode encontrar uma opção para selecionar os métodos de autenticação para a API, que incluem chave de API, autenticação básica, JWT etc., mapeando o aplicativo de autenticação criado para o respectivo método.
- Aplicar filtros (opcional): Você pode aplicar condições nas colunas, o que lhe permite acessar registros específicos com base nos filtros aplicados.
Para configurá-lo, você pode selecionar a coluna no menu suspenso Coluna de condição e, em seguida, escolher a Condição e o Parâmetro de URL nos quais deseja aplicar a condição.
- Clique em Gerar API.
- Agora sob o APIs personalizadas seção, você pode localizar sua API criada.
3. Teste as APIs geradas
- Para testar a API, clique em Testar opção sob o Ação suspenso.
- Um pop-up de teste aparecerá contendo o endpoint da sua API com o método HTTP configurado. Você pode encontrar a opção de passar os parâmetros nos cabeçalhos ou os dados no corpo, se necessário. Em seguida, clique em Executar.
- Se tudo estiver configurado corretamente, você verá uma resposta bem-sucedida, confirmando que sua API está funcionando conforme o esperado.
- Você pode consultar os formatos de solicitação e resposta de exemplo para sua solicitação de API na janela pop-up de teste.
Este guia permitirá que você configure e criar APIs REST personalizadas para o seu site DNN. Ao utilizar o plugin DNN REST API, você pode configurar, testar e gerenciar APIs DNN REST com segurança.
