Skapa externa REST API-slutpunkter i Dotnetnuke (DNN)
Översikt
DNN REST API-plugin möjliggör smidig integrering av externa API:er till DNN-webbplatser, vilket möjliggör hämtning och uppdatering av extern data genom API-anrop. Denna plugin gör det möjligt att hämta eller uppdatera extern data under olika DNN-händelser eller operationer, såsom användarinloggning, användarregistrering etc. Den här guiden ger dig en steg-för-steg-process för att ställa in External REST API för DNN-webbplatser.
Förutsättningar: Ladda ner och installation
- För att konfigurera externa API:er för DNN REST API måste du installera miniOrange DNN REST API Authentication plugin från DNN-butiken.
- Ladda upp installationspaketet genom att gå till Inställningar > Tillägg > Installera tillägg.
Konfigurationssteg
Steg-för-steg-guide för DNN External API-autentisering.
1. Lägg till modul på DNN-sidan
- Öppna någon av sidorna på din DNN-webbplats (redigeringsläge) och klicka på Lägg till modul.
- Sök efter DNN REST API och klicka på DNN REST API. Dra och släpp modulen på sidan där du vill.
- Du har slutfört installationen av DNN REST API-modulen på din DNN-webbplats.
2. Skapa externa API:er
- Navigera till DNN REST API-inställningar Flik. Här kommer du att se DNN REST API Plugin Dashboard.
- Klicka på Skapa API, för att initiera extern API-generering.
- Välj nu Externt API.
- Ange följande uppgifter:
- API-namn: Ange ett unikt namn för ditt API.
- API-metod: Välja HTTP-förfrågningsmetod från rullgardinsmenyn.
- Extern API-slutpunkt: Konfigurera din externa API-ändpunkt.
- Du kan konfigurera autentiseringsmetoden för API:t från auktoriseringsfliken och lägga till rubriker vid behov från fliken Rubriker.
- Du kan också skicka data i brödtexten i olika format inklusive JSON, x-www-form-urlencoded, xml etc. från Body-fliken.
- I avsnittet för avancerade inställningar har du möjlighet att skicka parametrarna.
- När du har angett detaljerna klickar du på Generera API.
- Nu, under avsnittet Externa APIs, kan du hitta ditt genererade API.
3. Testa externa API:er
- För att testa API:t, klicka på Testa alternativet under Handling falla ner.
- Ett testpopup-fönster visas. Ange nödvändiga uppgifter som rubriker eller kroppsdata och klicka sedan på Utförande knapp.
- Om allt är korrekt konfigurerat kommer ett framgångssvar att returneras av API:et som bekräftar att din externa API är korrekt konfigurerad.
Den här guiden gör det möjligt för dig att ställa in och integrera dina externa API:er i din DNN-applikation. Genom att använda denna REST API-integrering med DNN kan du säkert utföra hämtning, infogning, uppdatering och radering av extern data genom API-anrop från din DNN-applikation.
