SharePoint API e REST API: cosa sono e a cosa servono?
Le API sono il mezzo che rende possibile la comunicazione tra sistemi diversi, con uno scambio di dati e comandi. SharePoint, la principale piattaforma di collaborazione in Microsoft 365, sfrutta diverse tipologie di API per consentire agli utenti di creare, personalizzare e mantenere le web part che compongono i siti come la intranet aziendale. Tra queste API, le REST API svolgono un ruolo importante grazie alla loro flessibilità.
In questo articolo, vedremo nel dettaglio cosa sono e a cosa servono le API di SharePoint, cosa distingue le REST API e quali funzionalità sono possibili grazie all’integrazione con Microsoft Graph.
SharePoint API: cosa sono e a cosa servono?
In programmazione, le API rappresentano il mezzo tramite cui un programma riesce a comunicare con un altro programma o una fonte dati esterna. Nel caso di SharePoint, le API consentono la creazione delle web part di un sito come la intranet.
Gli sviluppatori utilizzano quindi le API per connettere SharePoint a specifiche fonti dati, da cui ricavare le informazioni necessarie per offrire contenuti e funzionalità nelle web part che compongono un sito.
Quando vengono aggiornate le informazioni di una fonte dati connessa a SharePoint tramite API, è importante sottolineare che i contenuti della relativa web part si aggiornano automaticamente e in tempo reale.
Le API di SharePoint si dividono in quattro categorie principali:
- REST API, che permettono l’accesso e la manipolazione delle risorse di SharePoint con semplici chiamate HTTP. In generale, le richieste RESTful eseguono operazioni CRUD (Create, Read, Update, Delete) su elementi in SharePoint come liste, documenti e siti.
- Client-Side Object Model (CSOM): la tipologia di API che fornisce un set di librerie da utilizzare in linguaggi come JavaScript, .NET e Silverlight per interagire con SharePoint. Queste API sono utili per svolgere operazioni lato client, dato che prevedono l’esecuzione di codice direttamente nel browser dell’utente.
- JavaScript Object Model (JOM): una categoria di API simile a quella CSOM, ma specifica per JavaScript. Viene quindi spesso utilizzata per creare le interfacce dinamiche delle web part di SharePoint.
- SOAP Web Services: anche se meno utilizzate rispetto le altre, queste API rendono possibile la comunicazione con SharePoint attraverso protocolli basati su XML.
L’insieme delle API di SharePoint permette di collegare le web part a un’ampia gamma di fonti dati, tra cui database esterni (per es. SQL Server), servizi cloud (come Microsoft Azure), sistemi ERP/CRM (per es. Dynamics 365 e Salesforce), e una miriade di altri servizi e applicazioni.
Prendendo a esempio il collegamento tramite API con un SQL Server, una web part potrebbe mostrare l’elenco dei progetti archiviati nel database. Questa integrazione consente agli utenti autorizzati di visualizzare le informazioni di loro interesse direttamente nella intranet di SharePoint, senza dover accedere a sistemi separati o trasferire manualmente i dati dopo un aggiornamento.
Ecco, quindi, cosa sono le API di SharePoint: i mattoncini di cui abbiamo bisogno per costruire, personalizzare e mantenere tutte le web part che arricchiscono le funzionalità e i contenuti di qualunque sito SharePoint.
Cos'è intranet.ai?
intranet.ai è la intranet aziendale pronta all'uso, progettata per ridurre i costi e i tempi di implementazione, e realizzare così un ambiente di lavoro digitale collaborativo e moderno:
- Prezzo iniziale di 3.650 €/anno per una intranet completa
- 50+ applicazioni, tra cui la ricerca avanzata, il sistema di gestione documentale, le notizie,
le notifiche push via Teams, il profilo personale e le FAQ - 100% integrata con SharePoint Online e Microsoft 365
SharePoint REST API: cosa sono e a cosa servono?
Le REST API, che stanno per Representational State Transfer Application Programming Interfaces, sono un insieme di principi architetturali per progettare e sviluppare sistemi di rete.
L'architettura REST si concentra sul concetto di risorse. Si basano infatti su un modello di comunicazione dove i client inviano richieste ai server per eseguire azioni su risorse specifiche. Queste richieste si manifestano tipicamente sotto forma di metodi HTTP come GET, POST, PUT, PATCH e DELETE, ciascuno dei quali corrisponde a diverse operazioni sulle risorse.
Nel caso specifico di SharePoint, le risorse su cui agiscono le REST API possono essere:
- Gli elementi di una lista
- I documenti di una libreria
- Un sito, nella sua interezza
I client possono quindi inviare richieste HTTP per svolgere azioni sulle risorse, come il recupero di determinate informazioni oppure l’apporto di modifiche. Un esempio è l’invio della richiesta GET per ottenere i dettagli di un documento presente in una libreria SharePoint; un secondo esempio potrebbe invece essere la richiesta POST, spesso utilizzata per aggiungere elementi a una lista.
Questa flessibilità rende le REST API uno strumento potente per integrare e automatizzare le interazioni con SharePoint, consentendo agli sviluppatori di costruire applicazioni che si interfacciano facilmente con i dati e le funzionalità della piattaforma.
Altri aspetti che caratterizzano le REST API di SharePoint riguardano:
- La facilità di utilizzo, permettendo di lavorare con dati strutturati e non in modo efficiente.
- La sicurezza, dato che l’autenticazione viene gestita tramite OAuth e token di accesso. Ciò significa che solo gli utenti e le applicazioni autorizzati possono interagire con le risorse.
- L’indipendenza dal contesto, dato che le richieste REST possono essere effettuate da qualsiasi ambiente che supporti le chiamate HTTP, inclusi browser e applicazioni mobile.
- La scalabilità, consentendo la gestione di un numero elevato di richieste simultanee senza sovraccaricare il server.
Qual è la differenza tra API e REST API in SharePoint?
Come abbiamo visto, le API sono insiemi di definizioni e protocolli che consentono a software diversi di comunicare tra loro. Ne esistono di vari tipi, tra cui API di librerie, API di sistema operativo o API di servizio web, che possono essere progettate utilizzando vari stili architetturali e protocolli come SOAP, GraphQL e REST.
Le REST API, nello specifico, rappresentano una tipologia di API che segue i principi architetturali del REST (Representational State Transfer). Questo stile è caratterizzato da un modello di comunicazione stateless, dove ogni richiesta del client al server contiene tutte le informazioni necessarie per eseguire l'operazione richiesta. Le REST API utilizzano i metodi HTTP (GET, POST, PUT, PATCH, DELETE) per eseguire operazioni sulle risorse, identificate da URL univoci.
Quindi: mentre tutte le REST API sono API, non tutte le API sono REST API.
Anche nel caso di SharePoint, le REST API sono solo uno dei tanti modi tramite cui è possibile interagire con piattaforme e fonti dati esterne. È utile utilizzare le REST API per creare le web part di SharePoint quando è necessaria una comunicazione leggera e flessibile con le fonti dati collegate.
Le REST API consentono infatti di costruire web part dinamiche e interattive, capaci di interfacciarsi con una varietà di fonti dati interne ed esterne senza compromettere la performance o la semplicità del codice.
Altre tipologie di API possono servire in contesti diversi. Per esempio, le SOAP API sono più adatte nel caso di integrazioni complesse che necessitano di un controllo maggiore sulla comunicazione. Allo stesso modo, le API di tipo CSOM vengono preferite dagli sviluppatori che lavorano con un modello a oggetti lato client, offrendo un'esperienza di sviluppo più naturale nelle applicazioni.
A quali fonti dati si può connettere SharePoint tramite API?
Grazie alle sue API, SharePoint può connettersi a un’ampia gamma di fonti dati e programmi per arricchire le proprie funzionalità e i contenuti di siti come la intranet.
Proprio nel caso della intranet, le web part possono sfruttare le API di SharePoint per collegarsi alle seguenti fonti di dati.
1. Liste e librerie di SharePoint
Le web part possono quindi gestire dati strutturati come annunci, contatti, eventi e attività. Semplificano inoltre la visualizzazione e la modifica dei contenuti presenti negli archivi di SharePoint, come i documenti aziendali o file multimediali.
2. Database esterni
Le web part si collegano a database SQL Server, consentendo agli utenti della intranet di accedere direttamente alle informazioni archiviate senza cambiare ambiente. Inoltre, le API permettono alle web part di connettersi anche a sistemi di Database Management, come Oracle, così da fornire una visione centralizzata dei dati aziendali.
3. Applicazioni di Microsoft 365
È possibile integrare nelle web part di SharePoint tramite API le informazioni provenienti dagli altri prodotti che costituiscono il digital workplace di Microsoft 365 (di cui fa parte SharePoint). Tra questi prodotti, troviamo:
- Outlook, per integrare e-mail, calendar e contatti.
- OneDrive, per semplificare la gestione dei file personali e condivisi.
- Teams, per integrare chat, canali e altre funzionalità di collaborazione.
- Planner, per aggiornare le attività di progetto e coordinare il lavoro del team.
4. Servizi cloud
Le web part di SharePoint possono comunicare con i servizi di Microsoft Azure, tra cui Azure Blob Storage, Azure Functions e Azure SQL Database. Inoltre, possono riportare i report e le dashboard di Power BI.
5. ERP/CRM
Le web part possono ottenere i dati presenti in sistemi come Microsoft Dynamics 365 e Salesforce. Le informazioni relative a clienti, vendite e attività di supporto diventano così consultabili nella intranet, supportando il lavoro degli utenti.
Ad esempio, il team Sales potrebbe visualizzare le recenti comunicazioni con i clienti gestite dal team di supporto e ottenere insight utili per gestire le trattative commerciali. Analogamente, il team di supporto può accedere ai dettagli delle vendite per analizzare i problemi dei clienti e proporre soluzioni personalizzate.
6. Strumenti di Business Intelligence
Oltre a Power BI, le web part di SharePoint si possono connettere tramite API a Tableau e Qlik. Si tratta di alcuni degli strumenti più famosi e utilizzati nelle aziende per l’analisi dati, e l’integrazione con SharePoint permette di centralizzare l’accesso alle informazioni nella intranet e di ottimizzare così i processi decisionali.
7. Social media e altri canali di comunicazione
Le web part si possono integrare con i profili social aziendali, per esempio quelli di LinkedIn o Twitter, per mostrare nella intranet gli ultimi post pubblicati o mettere in evidenza i contenuti più importanti per l’azienda. Oltre ai social media, si possono importare in SharePoint anche i contenuti in formato RSS (per es. le notizie provenienti da una rivista di settore online).
In intranet.ai, ci siamo basati proprio su questo utilizzo delle API di SharePoint per creare le web part “Post dai social media” e “RSS Feed”, con le quali i nostri clienti possono facilmente arricchire i contenuti della intranet costruita insieme.
SharePoint API e Microsoft Graph API:
esiste una relazione?
Microsoft Graph è una piattaforma di sviluppo che offre un gateway unificato per l'accesso ai dati e ai servizi di Microsoft 365, compresi Azure Active Directory, Outlook, OneDrive, Teams, Excel, Planner, e SharePoint.
Permette quindi di accedere ai molteplici servizi di Microsoft da un unico punto di ingresso, semplificando notevolmente lo sviluppo e la gestione delle applicazioni da parte degli sviluppatori. Graph supporta inoltre un’ampia gamma di operazioni, tra cui:
- interazione con i file e i documenti in OneDrive
- gestione della posta e del calendario in Outlook
- collaborazione e comunicazione in Microsoft Teams
- gestione delle identità utente in Azure Active Directory
Esiste quindi una stretta relazione tra le API dei prodotti Microsoft 365 e le API di Microsoft Graph, e SharePoint non fa eccezione.
L’integrazione delle API di SharePoint nell’ecosistema di Microsoft Graph permette agli sviluppatori di accedere ai dati e alle funzionalità di SharePoint tramite gli stessi endpoint e token di autenticazione utilizzati per altri servizi Microsoft 365. In pratica, le API di Microsoft Graph forniscono un'interfaccia uniforme per interagire con le risorse di SharePoint, rendendo più agevole l'interoperabilità tra SharePoint e gli altri servizi di Microsoft 365.
Con Microsoft Graph, è possibile ad esempio recuperare informazioni su un sito SharePoint, accedere a documenti archiviati in una libreria oppure gestire i permessi di accesso ai file aziendali. In modo semplice, attraverso chiamate HTTP.
Il risultato è una piattaforma robusta e integrata che semplifica il processo di sviluppo, consentendo alle aziende di sfruttare appieno le potenzialità dei loro dati e delle loro applicazioni.
Vuoi una intranet completa e pronta all'uso?
intranet.ai è la soluzione basata su SharePoint Online per semplificare la comunicazione interna e digitalizzare i processi aziendali con il minimo investimento di tempo e denaro.
- 50+ funzionalità per la comunicazione e l'employee experience
- Design di marca, personalizzabile in ogni dettaglio
- Integrazione completa con Microsoft 365 e Viva
Giuseppe Marchi
Microsoft MVP per SharePoint e Microsoft 365 dal 2010.
Giuseppe è il fondatore di intranet.ai e uno dei massimi esperti in Italia per tutto ciò che riguarda Microsoft 365. Da anni, aiuta le aziende a creare il proprio ambiente di lavoro digitale sul cloud di Microsoft, curando l'esperienza delle persone.
FAQ su SharePoint API e REST API
Cosa sono le API di SharePoint e a cosa servono?
Le API di SharePoint sono insiemi di definizioni e protocolli che consentono la comunicazione tra SharePoint e altre applicazioni o fonti dati esterne. Queste API permettono di creare, personalizzare e mantenere le web part che compongono siti come la intranet aziendale, garantendo l'integrazione e l'aggiornamento automatico dei contenuti.
Cosa sono le REST API di SharePoint e a cosa servono?
Le REST API di SharePoint sono un insieme di principi architetturali per progettare e sviluppare sistemi di rete. Permettono l'accesso e la manipolazione delle risorse di SharePoint tramite semplici chiamate HTTP, eseguendo operazioni CRUD (Create, Read, Update, Delete) su elementi come liste, documenti e siti.
Qual è la differenza tra API e REST API in SharePoint?
Le API sono insiemi di definizioni e protocolli per la comunicazione tra software diversi, mentre le REST API rappresentano una tipologia di API che segue i principi architetturali del REST (Representational State Transfer). Le REST API utilizzano metodi HTTP per eseguire operazioni sulle risorse, identificate da URL univoci. Non tutte le API sono REST API, ma tutte le REST API sono API.
A quali fonti dati si può connettere SharePoint tramite API?
SharePoint può connettersi a una vasta gamma di fonti dati tramite API, tra cui elenchi e librerie di SharePoint, database esterni (come SQL Server e Oracle), applicazioni di Microsoft 365 (Outlook, OneDrive, Teams, Planner), servizi cloud (Microsoft Azure, Power BI), ERP/CRM (Dynamics 365, Salesforce), strumenti di Business Intelligence (Tableau, Qlik) e canali di comunicazione come social media e RSS feed.
Esiste una relazione tra le API di SharePoint e Microsoft Graph API?
Sì, Microsoft Graph è una piattaforma che offre un gateway unificato per l'accesso ai dati e ai servizi di Microsoft 365, inclusi SharePoint. L'integrazione delle API di SharePoint in Microsoft Graph consente agli sviluppatori di accedere alle funzionalità di SharePoint tramite gli stessi endpoint e token di autenticazione utilizzati per altri servizi Microsoft 365, semplificando l'interoperabilità tra SharePoint e altri servizi Microsoft.
Continua a leggere
SharePoint: cos'è, a cosa serve e 7 funzionalità chiave
SharePoint è la piattaforma di Microsoft 365 per la gestione dei documenti e la creazione di siti aziendali. Vediamo come funziona.