SharePoint API och REST API: Vad är de till för?
API:er är de medel med vilka olika system kommunicerar med varandra och utbyter data och kommandon. SharePoint, den huvudsakliga samarbetsplattformen i Microsoft 365, utnyttjar olika typer av API:er för att göra det möjligt för användare att skapa, anpassa och underhålla de webbdelar som utgör webbplatser, till exempel företagets intranät. Bland dessa API:er spelar REST API:er en viktig roll på grund av deras flexibilitet.
I den här artikeln kommer vi att titta närmare på vad SharePoint API:er är och vad de används till, vad som skiljer REST API:er och vilken funktionalitet som är möjlig genom integration med Microsoft Graph.
SharePoint API: Vad är de?
I programmering representerar API: er det sätt på vilket ett program kan kommunicera med ett annat program eller en extern datakälla. När det gäller SharePoint möjliggör API: er skapandet av webbdelarna på en webbplats, till exempel intranätet.
Utvecklare använder sedan API:er för att ansluta SharePoint till specifika datakällor, från vilka de hämtar den information som behövs för att tillhandahålla innehåll och funktionalitet i de webb delar som utgör en webbplats.
När information från en datakälla som är ansluten till SharePoint via API uppdateras är det viktigt att notera att innehållet i den relaterade webbdelen uppdateras automatiskt och i realtid.
SharePoint API:er faller in i fyra huvudkategorier:
- REST API, som tillåter åtkomst och manipulation av SharePoint-resurser med enkla HTTP-anrop. I allmänhet utför RESTful-förfrågningar CRUD-operationer (Skapa, Läs, Uppdatera, Ta bort) på objekt i SharePoint, till exempel listor, dokument och webbplatser.
- Client-Side Object Model (CSOM): den typ av API som tillhandahåller en uppsättning bibliotek för användning i språk som JavaScript, .NET och Silverlight för att interagera med SharePoint. Dessa API: er är användbara för att utföra operationer på klientsidan, eftersom de involverar exekvering av kod direkt i användarens webbläsare.
- JavaScript Object Model (JOM): en kategori av API som liknar CSOM, men som är specifik för JavaScript. Det används därför ofta för att skapa de dynamiska gränssnitten för SharePoint webbdelar.
- SOAP Web Services: även om de används mindre än de andra, gör dessa API: er det möjligt att kommunicera med SharePoint via XML-baserade protokoll.
SharePoints uppsättning API:er gör det möjligt att ansluta webbdelar till ett brett utbud av datakällor, inklusive externa databaser (t.ex. SQL Server), molntjänster (t.ex. Microsoft Azure), ERP / CRM-system (t.ex. Dynamics 365 och Salesforce) och en mängd andra tjänster och applikationer.
Om vi tar API-anslutningen till en SQL Server som exempel kan en webbdel visa listan över projekt som finns lagrade i databasen. Denna integration gör det möjligt för auktoriserade användare att se den information de är intresserade av direkt på SharePoint-intranätet, utan att behöva komma åt separata system eller manuellt överföra data efter en uppdatering.
Detta är alltså vad SharePoint API:er är: de byggstenar vi behöver för att bygga, anpassa och underhålla alla de webbdelar som berikar funktionaliteten och innehållet på alla SharePoint-webbplatser.
Vad är intranet.ai?
intranet.ai är ett färdigt intranät för företag som är utformat för att minska kostnader och implementeringstider och därmed skapa en modern digital arbetsmiljö som präglas av samarbete:
- initialt pris på 3 650 €/år för ett komplett intranät
- över 50 applikationer, inklusive avancerad sökning, dokumenthanteringssystem och FAQ-sidor
- 100% integrerat med SharePoint Online och Microsoft 365
SharePoint REST API: Vad är de?
REST API:er, som står för Representational State Transfer Application Programming Interfaces, är en uppsättning arkitektoniska principer för att utforma och utveckla nätverkssystem.
REST-arkitekturen fokuserar på resursbegreppet. De är i själva verket baserade på en kommunikationsmodell där klienter skickar förfrågningar till servrar om att utföra åtgärder på specifika resurser. Dessa förfrågningar tar vanligtvis formen av HTTP-metoder som GET, POST, PUT, PATCH och DELETE, som var och en motsvarar olika operationer på resurserna.
I det specifika fallet med SharePoint kan de resurser som REST API agerar på vara:
- Elementen i en lista
- Dokumenten i ett bibliotek
- En webbplats, i sin helhet
Klienter kan sedan skicka HTTP-förfrågningar för att utföra åtgärder på resurserna, till exempel att hämta viss information eller göra ändringar. Ett exempel är att skicka en GET-begäran för att få detaljerna i ett dokument i ett SharePoint-bibliotek; ett andra exempel kan vara en POST-begäran, som ofta används för att lägga till objekt i en lista.
Denna flexibilitet gör REST API:er till ett kraftfullt verktyg för att integrera och automatisera interaktioner med SharePoint, vilket gör det möjligt för utvecklare att bygga applikationer som enkelt gränssnitt med plattformens data och funktionalitet.
Andra aspekter som kännetecknar SharePoints REST API:er inkluderar:
- Användarvänlighet, vilket gör att de kan arbeta med strukturerad och ostrukturerad data effektivt.
- Säkerhet, eftersom autentiseringen hanteras genom OAuth och access tokens. Detta innebär att endast auktoriserade användare och applikationer kan interagera med resurser.
- Kontextoberoende, eftersom REST-förfrågningar kan göras från alla miljöer som stöder HTTP-anrop, inklusive webbläsare och mobila applikationer.
- Skalbarhet, vilket gör det möjligt att hantera ett stort antal samtidiga förfrågningar utan att överbelasta servern.
Vad är skillnaden mellan API och REST API i SharePoint?
Som vi har sett är API: er uppsättningar av definitioner och protokoll som gör det möjligt för olika program att kommunicera med varandra. Det finns olika typer, inklusive biblioteks-API: er, operativsystem-API: er eller webbtjänst-API: er, som kan utformas med olika arkitektoniska stilar och protokoll som SOAP, GraphQL och REST.
REST API:er representerar en typ av API som följer de arkitektoniska principerna för REST (Representational State Transfer). Denna stil kännetecknas av en statslös kommunikationsmodell, där varje klientförfrågan till servern innehåller all information som krävs för att utföra den begärda operationen. REST API:er använder HTTP-metoder (GET, POST, PUT, PATCH, DELETE) för att utföra åtgärder på resurser som identifieras av unika URL:er.
Så: medan alla REST API:er är API:er, är inte alla API:er REST API:er.
Även när det gäller SharePoint är REST API: er bara ett av många sätt genom vilka du kan interagera med externa plattformar och datakällor. Det är användbart att använda REST API:er för att skapa SharePoint webbdelar när lätt och flexibel kommunikation med relaterade datakällor behövs.
Faktum är att REST API: er gör det möjligt att bygga dynamiska, interaktiva webbdelar som kan gränssnitt med en mängd olika interna och externa datakällor utan att kompromissa med prestanda eller kod enkelhet.
Andra typer av API:er kan användas i olika sammanhang. SOAP-API:er är till exempel bättre lämpade för komplexa integrationer som kräver mer kontroll över kommunikationen. På samma sätt föredras API:er av CSOM-typ av utvecklare som arbetar med en objektmodell på klientsidan, vilket ger en mer naturlig utvecklingsupplevelse i applikationer.
Vilka datakällor kan SharePoint ansluta till via API:er?
Genom sitt API kan SharePoint ansluta till ett brett utbud av datakällor och program för att berika dess funktionalitet och innehåll på webbplatser som intranätet.
Bara när det gäller intranätet kan webbdelar utnyttja SharePoints API för att ansluta till följande datakällor.
1. SharePoint listor och bibliotek
Webparts kan sedan hantera strukturerad data som meddelanden, kontakter, händelser och aktiviteter. De gör det också enkelt att visa och redigera innehåll i SharePoint-arkiv, t.ex. affärsdokument eller mediefiler.
2. Externa databaser
Webparts ansluter till SQL Server-databaser, vilket gör det möjligt för intranätanvändare att direkt komma åt arkiverad information utan att byta miljö. API:er gör det också möjligt för webbdelar att ansluta till databashanteringssystem, t.ex. Oracle, för att ge en centraliserad bild av företagsdata.
3. Microsoft 365-applikationer
Information från de andra produkterna som utgör den digitala arbetsplatsen Microsoft 365 (som SharePoint är en del av) kan integreras i SharePoint webbdelar via API: er. Dessa produkter inkluderar:
- Outlook, för att integrera e-post, kalender och kontakter.
- OneDrive, för att förenkla hanteringen av personliga och delade filer.
- Teams, för att integrera chatt, kanaler och andra samarbetsfunktioner.
- Planner, för att uppdatera projektaktiviteter och samordna teamarbete.
4. Molntjänster
SharePoint webbdelar kan kommunicera med Microsoft Azure-tjänster, inklusive Azure Blob Storage, Azure Functions och Azure SQL Database. Dessutom kan de rapportera på Power BI-rapporter och instrumentpaneler.
5. ERP/CRM
Webparts kan hämta data som finns i system som Microsoft Dynamics 365 och Salesforce. Information om kunder, försäljning och supportaktiviteter blir på så sätt sökbar på intranätet, vilket underlättar användarnas arbete.
Till exempel kan säljteamet se den senaste kundkommunikationen som hanterats av supportteamet och få insikter som är användbara för att hantera affärsförhandlingar. På samma sätt kan supportteamet få tillgång till försäljningsinformation för att analysera kundproblem och föreslå anpassade lösningar.
6. Verktyg för affärsintelligens
Förutom Power BI kan SharePoint webbdelar ansluta via API till Tableau och Qlik. Dessa är några av de mest populära och mest använda verktygen i företag för dataanalys, och integration med SharePoint möjliggör centraliserad åtkomst till information i intranätet och därmed effektivisera beslutsprocesserna.
7. Sociala medier och andra kommunikationskanaler
Webparts kan integreras med företagets sociala profiler, till exempel LinkedIn eller Twitter, för att i intranätet visa de senaste inläggen som publicerats eller lyfta fram det viktigaste innehållet för företaget. Förutom sociala medier kan även innehåll i RSS-format (t.ex. nyheter från en branschtidning på nätet) importeras till SharePoint.
På intranet.ai har vi byggt vidare på just denna användning av SharePoint API för att skapa webbdelarna "Inlägg i sociala medier" och "RSS-flöde", med vilka våra kunder enkelt kan berika innehållet i det intranät som vi har byggt tillsammans.
SharePoint API och Microsoft Graph API:
finns det en relation?
Microsoft Graph är en utvecklarplattform som tillhandahåller en enhetlig gateway för åtkomst till Microsoft 365-data och tjänster, inklusive Azure Active Directory, Outlook, OneDrive, Teams, Excel, Planner och SharePoint.
Den ger därmed tillgång till Microsofts många tjänster från en enda ingångspunkt, vilket förenklar applikationsutveckling och hantering för utvecklare. Graph stöder också ett brett spektrum av funktioner, inklusive:
- interaktion med filer och dokument i OneDrive
- e-post- och kalenderhantering i Outlook
- samarbete och kommunikation i Microsoft Teams
- hantering av användaridentiteter i Azure Active Directory
Det finns alltså en nära relation mellan Microsoft 365-produkt-API: er och Microsoft Graph API: er, och SharePoint är inget undantag.
Integrationen av SharePoint API:er i Microsoft Graph-ekosystemet gör det möjligt för utvecklare att komma åt SharePoint-data och funktionalitet via samma slutpunkter och autentiseringstoken som används för andra Microsoft 365-tjänster. I praktiken ger Microsoft Graph API: er ett enhetligt gränssnitt för att interagera med SharePoint-resurser, vilket gör interoperabilitet mellan SharePoint och andra Microsoft 365-tjänster enklare.
Med Microsoft Graph är det till exempel möjligt att hämta information på en SharePoint-webbplats, komma åt dokument som lagras i ett bibliotek eller hantera åtkomstbehörigheter till företagsfiler. Enkelt, genom HTTP-anrop.
Resultatet är en robust, integrerad plattform som förenklar utvecklingsprocessen och gör det möjligt för företag att utnyttja den fulla potentialen i sina data och applikationer.
Vill du ha ett komplett intranät?
"Intranet-in-a-box" är en komplett tjänst för ditt företag:
- Vi erbjuder dig ett varumärkesanpassat intranät integrerat med Microsoft 365 och Viva.
- Vi går bortom gränserna för en vanlig företagswebbplats med våra anpassningsbara funktioner.
- Vi uppdaterar alla komponenter till de senaste Microsoft-standarderna.
Förenkla den interna kommunikationen och digitalisera ditt företag med en minimal investering.
Giuseppe Marchi
Giuseppe är Microsoft MVP för SharePoint och Microsoft 365 sedan 2010 och grundade Dev4Side och intranet.ai i syfte att hjälpa företag att få en enklare och effektivare arbetsmiljö.
Han arbetar som konsult med allt som rör digitalt samarbete, intranätportaler och Microsofts molnplattformar.
FAQ om SharePoint API och REST API
Vad är SharePoint API:er och vad används de till?
SharePoint API:er är uppsättningar av definitioner och protokoll som möjliggör kommunikation mellan SharePoint och andra applikationer eller externa datakällor. Dessa API:er möjliggör skapande, anpassning och underhåll av webbdelar som utgör webbplatser som företagets intranät, vilket säkerställer integration och automatiska uppdateringar av innehåll.
Vad är SharePoint REST API:er och vad används de till?
SharePoint REST API:er är en uppsättning arkitektoniska principer för att designa och utveckla nätverkssystem. De möjliggör åtkomst till och hantering av SharePoint-resurser genom enkla HTTP-anrop, och utför CRUD-operationer (Create, Read, Update, Delete) på element som listor, dokument och webbplatser.
Vad är skillnaden mellan API:er och REST API:er i SharePoint?
API:er är uppsättningar av definitioner och protokoll för kommunikation mellan olika programvaror, medan REST API:er representerar en typ av API som följer de arkitektoniska principerna för REST (Representational State Transfer). REST API:er använder HTTP-metoder för att utföra operationer på resurser, identifierade av unika URL:er. Alla API:er är inte REST API:er, men alla REST API:er är API:er.
Vilka datakällor kan SharePoint ansluta till via API:er?
SharePoint kan ansluta till ett brett spektrum av datakällor via API:er, inklusive SharePoint-listor och -bibliotek, externa databaser (som SQL Server och Oracle), Microsoft 365-applikationer (Outlook, OneDrive, Teams, Planner), molntjänster (Microsoft Azure, Power BI), ERP/CRM-system (Dynamics 365, Salesforce), verktyg för affärsanalys (Tableau, Qlik) och kommunikationskanaler som sociala medier och RSS-flöden.
Finns det en relation mellan SharePoint API:er och Microsoft Graph API:er?
Ja, Microsoft Graph är en plattform som erbjuder en enhetlig gateway för åtkomst till data och tjänster i Microsoft 365, inklusive SharePoint. Integreringen av SharePoint API:er i Microsoft Graph gör det möjligt för utvecklare att komma åt SharePoints funktioner med samma ändpunkter och autentiseringstoken som används för andra Microsoft 365-tjänster, vilket förenklar interoperabiliteten mellan SharePoint och andra Microsoft-tjänster.
Fortsätt läsa
Vad är SharePoint och dess 7 viktigaste funktioner
Ta reda på vad SharePoint är och hur det kan hjälpa dig att digitalisera ditt företag.