Inleiding
API staat voor Application Programming Interface. Dit is een software-tussenlaag die het mogelijk maakt voor twee applicaties om met elkaar te communiceren via een set protocollen. Net zoals een webpagina wordt weergegeven, kunnen API's HTTP-verzoeken gebruiken om informatie van een webapplicatie of webserver op te halen. API's fungeren als 'boodschappers' tussen ons en de backend-systemen (server), waardoor we de gewenste gegevens kunnen ophalen.
API-basisprincipes
Om een API-verzoek te verzenden, kunt u Power Automate (of Zapier) gebruiken.
Workspace 365 gebruikt een 'RESTful API' (ook wel een RESTful webservice of REST API genoemd). REST maakt veel gebruik van HTTP. Workspace kan gegevens opvragen via een van de Workspace API's en ontvangt een antwoord van het API-eindpunt.
Het eindpunt kan worden gezien als het middel waarmee de API toegang krijgt tot de benodigde bronnen van een server om hun taak uit te voeren. Dit betekent dat het eindpunt hun eigen API of webhook nodig heeft (houd er rekening mee dat de gegevens extern toegankelijk moeten zijn), die communiceert met onze Workspace API en ons de gewenste gegevens terugstuurt.
ā
ā
Er zijn vier soorten HTTP-methoden (verzoeken):
GET - Deze methode wordt gebruikt om gegevens op te halen.
POST - Deze methode wordt gebruikt om gegevens toe te voegen.
PUT - Deze methode wordt gebruikt om gegevens te bewerken.
DELETE - Deze methode wordt gebruikt om gegevens te verwijderen.
API in de praktijk brengen
Als u een visueel voorbeeld wilt zien van hoe het werkt, kunt u de Masterclass Activity Feed API in Workspace 365 bekijken.
Misschien wilt u een melding in de Activity Feed tonen wanneer u een nieuwe e-mail van een specifieke gebruiker ontvangt? Met Power Automate (of Zapier) kunt u een HTTP POST-verzoek verzenden via onze Activity Feed API naar de URL van het API-eindpunt. Na het verzenden van het HTTP-verzoek, ontvangt onze Workspace API een antwoord van het API-eindpunt waarin staat of het verzoek succesvol was of niet. Verder is het cruciaal om de gegevens te beschermen die worden overgedragen tussen het HTTP-verzoek en het HTTP-antwoord.
Enkele vereisten:
Methode - Definieer uw HTTP-methode. In dit voorbeeld is het POST.
URL - Specificeer waar het verzoek naartoe wordt gestuurd. Dit is de Workspace-URL en het API-eindpunt.
API-headers - Een extra informatiebron voor elk API-verzoek dat u doet, inclusief:
Taal - De API stelt de HTTP-antwoordcode en het inhoudstype in volgens het gevraagde formaat, in dit geval JSON.
Autorisatie - Een API-sleutel of Provisioning Key, die wordt gebruikt om te controleren of het is toegestaan om het API-verzoek te doen.
Bij elk verzoek dat u doet, voegt u een body (schema!) toe waarin u definieert wie de melding ontvangt, kleuren, acties bij de melding, enz.
Hoe u onze API-documentatie kunt gebruiken
Het is belangrijk om het verschil te weten tussen de twee Workspace API's die we aanbieden en hun bijbehorende API-eindpunten.
Beschikbaar voor iedereen en bevat API-eindpunten voor:
Activity Feed API (bijv. activiteiten aanmaken voor bepaalde gebruikers).
Beschikbare gebruikersapps (bijv. alle beschikbare apps voor een bepaalde gebruiker ophalen).
Aankondigingen API (bijv. aankondigingen maken).
App-pictogrammen API (bijv. een lijst van app-pictogrammen ophalen).
Integratie-credentials API (bijv. integratie-credentials aanmaken of bijwerken).
Beschikbaar voor partners en bevat API-eindpunten voor:
Omgevings-API (bijv. een omgeving aanmaken of verwijderen).
Licentie-API (een licentie-overzicht en klantinformatie ophalen).
Template-API (bijv. een omgevingsconfiguratie importeren).
Exchange-API (de Exchange-services instellingen configureren).
SharePoint-API (de SharePoint-services instellingen configureren).