SharePoint API ja REST API: Mitä varten ne ovat?
API:t ovat keinoja, joiden avulla eri järjestelmät kommunikoivat keskenään ja vaihtavat tietoja ja komentoja. SharePoint, Microsoft 365:n tärkein yhteistyöalusta, hyödyntää erityyppisiä API-rajapintoja, jotta käyttäjät voivat luoda, mukauttaa ja ylläpitää web-osia, jotka muodostavat sivustoja, kuten yrityksen intranetin. Näistä API:ista REST API:t ovat tärkeässä asemassa joustavuutensa ansiosta.
Tässä artikkelissa tarkastelemme yksityiskohtaisesti, mitä SharePoint API:t ovat ja mihin niitä käytetään, mikä REST API:t erottaa toisistaan ja mitä toimintoja on mahdollista integroida Microsoft Graphin kanssa.
SharePoint API: Mitä ne ovat?
Ohjelmoinnissa API:t ovat keinoja, joiden avulla ohjelma voi kommunikoida toisen ohjelman tai ulkoisen tietolähteen kanssa. SharePointin tapauksessa API:t mahdollistavat sivuston, kuten intranetin, web-osien luomisen.
Tämän jälkeen kehittäjät käyttävät API:ita SharePointin liittämiseen tiettyihin tietolähteisiin, joista he saavat tiedot, joita tarvitaan sisällön ja toimintojen tarjoamiseen sivuston muodostavissa web-osissa.
Kun SharePointiin API:n kautta liitetyn tietolähteen tietoja päivitetään, on tärkeää huomata, että siihen liittyvän web-osion sisältö päivittyy automaattisesti ja reaaliaikaisesti.
SharePointin API:t jakautuvat neljään pääluokkaan:
- REST API:t, jotka mahdollistavat SharePoint-resurssien käytön ja käsittelyn yksinkertaisilla HTTP-kutsuilla. Yleensä REST-pyynnöillä suoritetaan CRUD (Create, Read, Update, Delete) -operaatioita SharePointin kohteille, kuten luetteloille, asiakirjoille ja sivustoille.
- Client-Side Object Model (CSOM): API-tyyppi, joka tarjoaa joukon kirjastoja, joita voidaan käyttää esimerkiksi JavaScript-, .NET- ja Silverlight-kielissä SharePointin kanssa. Nämä API:t ovat hyödyllisiä asiakaspuolen toimintojen suorittamisessa, koska niissä suoritetaan koodia suoraan käyttäjän selaimessa.
- JavaScript Object Model (JOM): CSOM:n kaltainen API-luokka, mutta se on tarkoitettu erityisesti JavaScriptille. Siksi sitä käytetään usein SharePointin web-osien dynaamisten käyttöliittymien luomiseen.
- SOAP-verkkopalvelut: Vaikka nämä API:t ovat vähemmän käytettyjä kuin muut, ne mahdollistavat yhteydenpidon SharePointin kanssa XML-pohjaisten protokollien avulla.
SharePointin API-kokonaisuus mahdollistaa web-osien liittämisen monenlaisiin tietolähteisiin, kuten ulkoisiin tietokantoihin (esim. SQL Server), pilvipalveluihin (kuten Microsoft Azure), ERP/CRM-järjestelmiin (esim. Dynamics 365 ja Salesforce) sekä lukuisiin muihin palveluihin ja sovelluksiin.
Kun esimerkkinä on API-yhteys SQL-palvelimeen, web-osa voisi näyttää luettelon tietokantaan tallennetuista projekteista. Tämän integraation ansiosta valtuutetut käyttäjät voivat tarkastella haluamiaan tietoja suoraan SharePoint-intranetissä ilman, että heidän tarvitsee käyttää erillisiä järjestelmiä tai siirtää tietoja manuaalisesti päivityksen jälkeen.
Tällaisia SharePointin API:t siis ovat: rakennuspalikoita, joita tarvitsemme kaikkien niiden web-osien rakentamiseen, mukauttamiseen ja ylläpitoon, jotka rikastuttavat minkä tahansa SharePoint-sivuston toimintoja ja sisältöä.
Mikä on intranet.ai?
intranet.ai on käyttövalmis yritysintranet, joka on suunniteltu vähentämään kustannuksia ja toteuttamisaikaa ja luomaan siten yhteistoiminnallinen ja moderni digitaalinen työympäristö:
- Alustava hinta 3 650 €/vuosi täydellisestä intranetistä
- yli 50 sovellusta, mukaan lukien kehittynyt haku, asiakirjojen hallintajärjestelmä ja FAQ-sivut
- 100-prosenttisesti integroitu SharePoint Onlineen ja Microsoft 365:een
SharePoint REST API: Mitä ne ovat?
REST-API:t, jotka tarkoittavat Representational State Transfer Application Programming Interfaces -sovellusohjelmointirajapintoja, ovat joukko arkkitehtuuriperiaatteita verkkojärjestelmien suunnittelua ja kehittämistä varten.
REST-arkkitehtuurissa keskitytään resurssien käsitteeseen. Ne perustuvat itse asiassa viestintämalliin, jossa asiakkaat lähettävät palvelimille pyyntöjä suorittaa toimia tietyillä resursseilla. Nämä pyynnöt ovat tyypillisesti HTTP-menetelmiä, kuten GET, POST, PUT, PATCH ja DELETE, joista kukin vastaa erilaisia resursseihin kohdistuvia toimintoja.
SharePointin tapauksessa resurssit, joihin REST API vaikuttaa, voivat olla:
- Luettelon elementit
- Kirjaston asiakirjat
- Sivusto kokonaisuudessaan
Asiakkaat voivat sitten lähettää HTTP-pyyntöjä suorittaakseen resursseihin kohdistuvia toimia, kuten hakeakseen tiettyjä tietoja tai tehdäkseen muutoksia. Yksi esimerkki on GET-pyynnön lähettäminen SharePoint-kirjastossa olevan asiakirjan tietojen saamiseksi; toinen esimerkki voi olla POST-pyyntö, jota käytetään usein elementtien lisäämiseen luetteloon.
Tämä joustavuus tekee REST API:ista tehokkaan työkalun SharePointin kanssa tapahtuvan vuorovaikutuksen integrointiin ja automatisointiin, jolloin kehittäjät voivat rakentaa sovelluksia, jotka ovat helposti yhteydessä alustan tietoihin ja toimintoihin.
Muita SharePointin REST-API:itä luonnehtivia seikkoja ovat muun muassa seuraavat:
- Helppokäyttöisyys, jonka ansiosta niillä voidaan työskennellä tehokkaasti strukturoitujen ja strukturoimattomien tietojen kanssa.
- Turvallisuus, sillä todennus hoidetaan OAuthin ja käyttöoikeustunnisteiden avulla. Tämä tarkoittaa, että vain valtuutetut käyttäjät ja sovellukset voivat olla vuorovaikutuksessa resurssien kanssa.
- Kontekstiriippumattomuus, sillä REST-pyynnöt voidaan tehdä mistä tahansa ympäristöstä, joka tukee HTTP-pyyntöjä, kuten selaimista ja mobiilisovelluksista.
- Skaalautuvuus, koska suuri määrä samanaikaisia pyyntöjä voidaan käsitellä ylikuormittamatta palvelinta.
Mitä eroa on SharePointin API- ja REST-API:iden välillä?
Kuten olemme nähneet, API:t ovat määrittelyjen ja protokollien kokonaisuuksia, joiden avulla eri ohjelmistot voivat kommunikoida keskenään. Niitä on erityyppisiä, kuten kirjasto-, käyttöjärjestelmä- tai verkkopalvelu-rajapintoja, jotka voidaan suunnitella käyttäen erilaisia arkkitehtuurityylejä ja protokollia, kuten SOAP, GraphQL ja REST.
REST API:t edustavat erityisesti API-tyyppiä, joka noudattaa REST-arkkitehtuurin (Representational State Transfer) periaatteita. Tälle tyylille on ominaista tilaton viestintämalli, jossa jokainen asiakkaan palvelimelle lähettämä pyyntö sisältää kaikki pyydetyn toiminnon suorittamiseen tarvittavat tiedot. REST API:t käyttävät HTTP-menetelmiä (GET, POST, PUT, PATCH, DELETE) suorittaakseen operaatioita resursseille, jotka tunnistetaan yksilöllisillä URL-osoitteilla.
Eli: vaikka kaikki REST API:t ovat API:ita, kaikki API:t eivät ole REST API:ita.
Jopa SharePointin tapauksessa REST API:t ovat vain yksi monista tavoista, joiden avulla voit olla vuorovaikutuksessa ulkoisten alustojen ja tietolähteiden kanssa. REST API:iden käyttäminen SharePointin web-osien luomiseen on hyödyllistä silloin, kun tarvitaan kevyttä ja joustavaa viestintää toisiinsa liittyvien tietolähteiden kanssa.
REST API:t mahdollistavat itse asiassa dynaamisten, vuorovaikutteisten web-osien rakentamisen, jotka pystyvät olemaan yhteydessä erilaisiin sisäisiin ja ulkoisiin tietolähteisiin suorituskyvystä tai koodin yksinkertaisuudesta tinkimättä.
Muuntyyppisiä sovellusrajapintoja voidaan käyttää eri yhteyksissä. Esimerkiksi SOAP API:t soveltuvat paremmin monimutkaisiin integraatioihin, joissa viestintää on hallittava paremmin. Vastaavasti CSOM-tyyppisiä API:ita suosivat kehittäjät, jotka työskentelevät asiakaspuolen objektimallin kanssa ja tarjoavat sovelluksille luonnollisemman kehityskokemuksen.
Mihin tietolähteisiin SharePoint voi muodostaa yhteyden API:iden kautta?
API:nsa kautta SharePoint voi muodostaa yhteyden monenlaisiin tietolähteisiin ja ohjelmiin, jotka rikastuttavat sen toimintoja ja sisältöä esimerkiksi intranetissä.
Pelkästään intranetin tapauksessa web-osat voivat hyödyntää SharePointin API:ta ja muodostaa yhteyden seuraaviin tietolähteisiin.
1. SharePointin luettelot ja kirjastot
Web-osat voivat tällöin hallita strukturoituja tietoja, kuten ilmoituksia, yhteystietoja, tapahtumia ja aktiviteetteja. Niiden avulla on myös helppo tarkastella ja muokata SharePointin arkistojen sisältöä, kuten liiketoiminta-asiakirjoja tai mediatiedostoja.
2. Ulkoiset tietokannat
Web-osat muodostavat yhteyden SQL Server -tietokantoihin, jolloin intranetin käyttäjät voivat käyttää arkistoituja tietoja suoraan ilman ympäristön vaihtamista. Lisäksi API:iden avulla web-osat voivat myös muodostaa yhteyden tietokannan hallintajärjestelmiin, kuten Oracleen, jotta voidaan tarjota keskitetty näkymä yritystietoihin.
3. Microsoft 365 -sovellukset
Microsoft 365 -digitaalisen työympäristön (jonka osa SharePoint on) muodostavien muiden tuotteiden tiedot voidaan integroida SharePointin web-osiin API:iden kautta. Näitä tuotteita ovat mm:
- Outlook, sähköpostin, kalenterin ja yhteystietojen integrointiin.
- OneDrive, jolla yksinkertaistetaan henkilökohtaisten ja jaettujen tiedostojen hallintaa.
- Teams, jolla voidaan integroida chat, kanavat ja muut yhteistyöominaisuudet.
- Planner, jolla päivitetään projektitoimintoja ja koordinoidaan tiimityötä.
4. Pilvipalvelut
SharePointin web-osat voivat kommunikoida Microsoft Azuren palveluiden kanssa, kuten Azure Blob Storage, Azure Functions ja Azure SQL Database. Lisäksi ne voivat raportoida Power BI -raportteihin ja -näyttötauluihin.
5. ERP/CRM
Web-osat voivat saada tietoja, jotka löytyvät esimerkiksi Microsoft Dynamics 365- ja Salesforce-järjestelmistä. Asiakkaita, myyntiä ja tukitoimintoja koskevat tiedot tulevat näin haettaviksi intranetissä, mikä tukee käyttäjien työtä.
Myyntitiimi voi esimerkiksi tarkastella tukitiimin hallinnoimaa viimeaikaista asiakasviestintää ja saada tietoa, josta on hyötyä liikeneuvottelujen hallinnoinnissa. Vastaavasti tukitiimi voi käyttää myyntitietoja analysoidakseen asiakkaiden ongelmia ja ehdottaakseen räätälöityjä ratkaisuja.
6. Business Intelligence -työkalut
Power BI:n lisäksi SharePointin web-osat voivat muodostaa API:n kautta yhteyden Tableauhun ja Qlikiin. Nämä ovat suosituimpia ja laajimmin yrityksissä käytettyjä työkaluja tietojen analysointiin, ja integrointi SharePointin kanssa mahdollistaa keskitetyn pääsyn tietoihin intranetissä ja siten päätöksentekoprosessien virtaviivaistamisen.
7. Sosiaalinen media ja muut viestintäkanavat
Web-osat voidaan integroida yrityksen sosiaalisiin profiileihin, esimerkiksi LinkedInin tai Twitterin profiileihin, jotta intranetissä voidaan näyttää viimeisimmät julkaistut viestit tai korostaa yrityksen kannalta tärkeintä sisältöä. Sosiaalisen median lisäksi SharePointiin voidaan tuoda myös RSS-muodossa olevaa sisältöä (esim. verkkokauppa-lehden uutisia).
Me intranet.ai:ssa olemme juuri tämän SharePoint API:n käytön pohjalta luoneet "Sosiaalisen median viestit" ja "RSS-syöte" web-osat, joilla asiakkaamme voivat helposti rikastuttaa yhdessä rakentamamme intranetin sisältöä.
SharePoint API ja Microsoft Graph API:
onko niillä yhteys?
Microsoft Graph on kehittäjäalusta, joka tarjoaa yhtenäisen yhdyskäytävän Microsoft 365 -tietojen ja -palvelujen, kuten Azure Active Directory, Outlook, OneDrive, Teams, Excel, Planner ja SharePoint, käyttämiseen.
Se tarjoaa siis pääsyn Microsoftin useisiin palveluihin yhdestä sisäänkäyntipisteestä, mikä yksinkertaistaa huomattavasti sovelluskehitystä ja -hallintaa kehittäjille. Graph tukee myös monenlaisia toimintoja, mm:
- vuorovaikutus OneDriven tiedostojen ja asiakirjojen kanssa
- sähköpostin ja kalenterin hallinta Outlookissa
- yhteistyö ja viestintä Microsoft Teamsissa
- käyttäjäidentiteettien hallinta Azure Active Directoryssa
Microsoft 365 -tuotteen sovellusrajapintojen ja Microsoft Graph -rajapintojen välillä on siis läheinen yhteys, eikä SharePoint ole poikkeus.
SharePointin sovellusrajapintojen integrointi Microsoft Graph -ekosysteemiin antaa kehittäjille mahdollisuuden käyttää SharePointin tietoja ja toimintoja samojen päätepisteiden ja todennuskoodien kautta, joita käytetään muissa Microsoft 365 -palveluissa. Käytännössä Microsoft Graph API:t tarjoavat yhtenäisen käyttöliittymän SharePoint-resurssien kanssa toimimiseen, mikä helpottaa SharePointin ja muiden Microsoft 365 -palveluiden välistä yhteentoimivuutta.
Microsoft Graphin avulla voidaan esimerkiksi hakea tietoja SharePoint-sivustosta, käyttää kirjastoon tallennettuja asiakirjoja tai hallita yrityksen tiedostojen käyttöoikeuksia. Helposti, HTTP-kutsujen kautta.
Tuloksena on vankka, integroitu alusta, joka yksinkertaistaa kehitysprosessia ja antaa yrityksille mahdollisuuden hyödyntää tietojensa ja sovellustensa koko potentiaali.
Haluatko täydellisen, käyttövalmiin intranetin?
"Intranet-in-a-box" on täydellinen palvelu yrityksellesi:
- Tarjoamme sinulle tuotemerkillä varustetun intranetin, joka on jo integroitu Microsoft 365:een ja Vivan kanssa.
- Ylittämme tavallisen yrityssivuston rajat muokattavilla ominaisuuksillamme.
- Päivitämme kaikki komponentit uusimpien Microsoft-standardien mukaisiksi.
Yksinkertaista sisäistä viestintää ja digitalisoi yrityksesi minimaalisella investoinnilla.
Giuseppe Marchi
Giuseppe on ollut SharePointin ja Microsoft 365:n Microsoft MVP vuodesta 2010 lähtien. Hän perusti Dev4Siden ja intranet.ai:n tavoitteenaan auttaa yrityksiä luomaan yksinkertaisempi ja tehokkaampi työympäristö.
Hän toimii konsulttina kaikessa, mikä liittyy digitaaliseen yhteistyöhön, intranet-portaaleihin ja Microsoftin pilvialustoihin.
FAQ SharePoint API:ista ja REST API:ista
Mitä SharePoint API:t ovat ja mihin niitä käytetään?
SharePoint API:t ovat joukko määritelmiä ja protokollia, jotka mahdollistavat viestinnän SharePointin ja muiden sovellusten tai ulkoisten tietolähteiden välillä. Nämä API:t mahdollistavat verkkokomponenttien luomisen, mukauttamisen ja ylläpidon, jotka muodostavat esimerkiksi yrityksen intranetin, varmistaen integraation ja automaattiset sisällön päivitykset.
Mitä SharePoint REST API:t ovat ja mihin niitä käytetään?
SharePoint REST API:t ovat joukko arkkitehtonisia periaatteita verkkojärjestelmien suunnitteluun ja kehittämiseen. Ne mahdollistavat pääsyn SharePoint-resursseihin ja niiden käsittelyn yksinkertaisten HTTP-kutsujen avulla, suorittaen CRUD-toimintoja (Create, Read, Update, Delete) kohteisiin kuten listoihin, asiakirjoihin ja sivustoihin.
Mitä eroa on SharePointin API:illa ja REST API:illa?
API:t ovat joukko määritelmiä ja protokollia eri ohjelmistojen väliseen viestintään, kun taas REST API:t edustavat eräänlaista API:ta, joka noudattaa REST:n (Representational State Transfer) arkkitehtonisia periaatteita. REST API:t käyttävät HTTP-menetelmiä suorittaakseen operaatioita resursseihin, jotka tunnistetaan yksilöllisillä URL-osoitteilla. Kaikki API:t eivät ole REST API:ita, mutta kaikki REST API:t ovat API:ita.
Mihin tietolähteisiin SharePoint voi yhdistää API:iden kautta?
SharePoint voi yhdistää laajaan valikoimaan tietolähteitä API:iden kautta, mukaan lukien SharePoint-listat ja -kirjastot, ulkoiset tietokannat (kuten SQL Server ja Oracle), Microsoft 365 -sovellukset (Outlook, OneDrive, Teams, Planner), pilvipalvelut (Microsoft Azure, Power BI), ERP/CRM-järjestelmät (Dynamics 365, Salesforce), liiketoimintatiedon työkalut (Tableau, Qlik) ja viestintäkanavat kuten sosiaalinen media ja RSS-syötteet.
Onko SharePoint API:iden ja Microsoft Graph API:iden välillä yhteyttä?
Kyllä, Microsoft Graph on alusta, joka tarjoaa yhtenäisen pääsyn Microsoft 365:n tietoihin ja palveluihin, mukaan lukien SharePoint. SharePoint API:iden integrointi Microsoft Graphiin mahdollistaa kehittäjille pääsyn SharePointin toiminnallisuuksiin käyttämällä samoja päätepisteitä ja todennustunnuksia, joita käytetään muihin Microsoft 365 -palveluihin, yksinkertaistaen SharePointin ja muiden Microsoft-palveluiden välistä yhteentoimivuutta.
Jatka lukemista
Mikä on SharePoint ja sen 7 keskeistä ominaisuutta
Lue, mikä SharePoint on ja miten se voi auttaa sinua digitalisoimaan yrityksesi.