SharePoint API e REST API: cosa sono e a cosa servono?

SharePoint API: cosa sono e a cosa servono?

Le API sono il mezzo tramite cui un programma riesce a comunicare con un programma differente o con una fonte dati esterna.

Nel caso di SharePoint Online, le API consentono di arricchire un sito, come la intranet aziendale, attraverso lo sviluppo di componenti personalizzati e dinamici.

Gli sviluppatori utilizzano le API per connettere SharePoint a specifiche fonti dati, da cui ricavare informazioni utili per creare funzionalità e contenuti direttamente integrati nelle web part di un sito.

Ad esempio, una web part può essere collegata a un database esterno per mostrare l'elenco dei progetti archiviati, permettendo agli utenti autorizzati di accedere rapidamente alle informazioni di loro interesse.

Quando le informazioni in una fonte dati connessa a SharePoint tramite API vengono aggiornate, i contenuti delle web part possono essere sincronizzati.

Tuttavia, l'aggiornamento in tempo reale dipende dalla configurazione: spesso è necessario un refresh manuale della pagina o l’implementazione di soluzioni personalizzate, come script specifici o funzionalità di auto-aggiornamento.

Le API di SharePoint si dividono in quattro categorie principali. Vediamole nella tabella seguente.

 

SharePoint API: principali tipologie

 

Tipologie di SharePoint API	Descrizione
REST API	Consentono l’accesso e la manipolazione delle risorse di SharePoint tramite semplici chiamate HTTP. Le richieste RESTful permettono di eseguire operazioni CRUD (Create, Read, Update, Delete) su elementi come liste, documenti e siti, rendendole uno strumento chiave per molte integrazioni.
Client-Side Object Model	Un set di librerie utilizzabili in linguaggi come JavaScript, .NET e Silverlight. Le API CSOM sono utili per svolgere operazioni lato client, eseguendo codice direttamente nel browser dell’utente o in applicazioni desktop.
JavaScript Object Model	Una variante di CSOM specifica per JavaScript, utilizzata principalmente per creare interfacce dinamiche nelle web part di SharePoint. Viene ampiamente adottata per la personalizzazione dei siti aziendali.
SOAP Web Services	Nonostante siano meno utilizzate rispetto alle altre, queste API permettono la comunicazione con SharePoint attraverso protocolli basati su XML. Sebbene abbiano un ruolo secondario, restano utili in scenari legacy o per realizzare particolari integrazioni.

 

Grazie alle API, come dicevamo, è possibile connettere SharePoint a una vasta gamma di fonti dati e servizi esterni, tra cui database (come SQL Server), servizi cloud (come Microsoft Azure) e sistemi ERP/CRM (come Dynamics 365 e Salesforce).

Queste integrazioni permettono di centralizzare le informazioni all'interno della intranet aziendale o di un qualunque sito basato su SharePoint Online, eliminando la necessità per gli utenti di accedere a sistemi separati per ottenere le informazioni di loro interesse o di trasferire manualmente i dati dopo ogni aggiornamento.

Le API rappresentano, quindi, i mattoncini fondamentali per costruire, personalizzare e mantenere tutte le web part che arricchiscono le funzionalità e i contenuti di un sito SharePoint, offrendo un ecosistema potente e flessibile per soddisfare qualunque esigenza.

 

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 essere la richiesta POST, spesso utilizzata per aggiungere nuovi 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:

• Facilità di utilizzo, permettendo di lavorare con dati strutturati, e non, in modo efficiente.
  
  
• 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.
  
  
• Indipendenza dal contesto, dato che le richieste REST possono essere effettuate da qualsiasi ambiente che supporti le chiamate HTTP, inclusi browser e applicazioni mobile.
  
  
• Scalabilità, consentendo la gestione di un numero elevato di richieste simultanee senza sovraccaricare il server.
  
  

Ma come si possono usare, nel concreto, le REST API di SharePoint in azienda?

Come dicevamo, le REST API sono uno strumento chiave nell'ecosistema di SharePoint Online per automatizzare processi, integrare sistemi e creare soluzioni personalizzate per arricchire siti come la intranet e la extranet. Dunque, un primo caso d'uso potrebbe riguardare l’automazione della gestione documentale.

Un contratto firmato, ad esempio, può essere caricato in una libreria SharePoint con metadati predefiniti, rendendolo facilmente reperibile per il team legale. Allo stesso modo, i dati archiviati possono essere utilizzati per costruire dashboard interattive, integrandoli con strumenti come Power BI per monitorare i KPI o lo stato di avanzamento di un progetto.

Inoltre, è possibile creare sistemi di notifiche o approvazioni con cui semplificare la gestione delle attività quotidiane. In questo caso, un esempio potrebbe essere l'uso delle REST API per l’invio automatico di un’email al responsabile quando un elemento inserito in una determinata lista SharePoint richiede la sua convalida.

Le REST API trovano applicazione anche nella creazione di portali dedicati ai lavoratori, come quelli creati per accedere ai documenti personali o per inviare ticket di supporto. Ancora, possono integrarsi con sistemi di terze parti, come CRM o strumenti per la gestione delle risorse umane, per centralizzare le informazioni relative a personale, fornitori e clienti.

 

 

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.

In particolar modo, è utile utilizzare le REST API per creare le web part di un sito 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 situazioni diverse.

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 API, SharePoint Online può connettersi a un’ampia gamma di fonti dati e programmi per arricchire le funzionalità e i contenuti di siti come la intranet aziendale. 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 interagire con le liste e le librerie di SharePoint tramite API per gestire dati strutturati come annunci, contatti, eventi e attività. Ciò consente una visualizzazione intuitiva e la modifica diretta dei contenuti, inclusi documenti aziendali e file multimediali, senza dover uscire dal sito SharePoint in cui si trova la web part.

 

Web part per promuovere le notizie aziendali nella intranet SharePoint di intranet.ai

2. Database esterni

Sebbene le REST API di SharePoint non supportino una connessione diretta con database esterni, in passato era possibile utilizzare i Servizi di integrazione applicativa (Business Connectivity Services, o BCS) per collegarsi a database relazionali oppure origini OData. Tuttavia, Microsoft ha dismesso definitivamente i BCS a partire dal 30 settembre 2024.

Oggi, è quindi consigliabile utilizzare strumenti come Power Apps e Power Automate per integrare tali informazioni in SharePoint, dato che offrono connettori dedicati per collegare in modo sicuro e flessibile database relazionali. Questi strumenti permettono inoltre di creare interfacce intuitive per gestire i dati direttamente all'interno della intranet, senza bisogno di soluzioni intermedie.

 

Integrare dati in SharePoint tramite Power Apps

3. Applicazioni di Microsoft 365

Tramite API, è possibile integrare nelle web part di SharePoint le informazioni provenienti dagli altri prodotti che costituiscono il digital workplace di Microsoft 365. Tra questi, troviamo:

• Outlook, per integrare email, calendari 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.

 

Web part di Microsoft Planner per SharePoint

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.

 

Integrazione di un report di Power BI in SharePoint Online

5. ERP/CRM

Le web part di SharePoint 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 potrebbe accedere ai dettagli delle vendite per analizzare i problemi dei clienti e proporre soluzioni con cui risolverle.

 

Integrazione dei dati in Microsoft Dynamics 365 in SharePoint

6. 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’organizzazione.

 

Web part "Post dai social media" di intranet.ai

Oltre ai social media, si possono importare in SharePoint anche i contenuti in formato RSS, come le notizie provenienti da una rivista di settore online.

 

Web part "RSS Feed" di intranet.ai

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 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 lo stesso 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.

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.