Developers Docs

Dev docs

Pluvo API Documentatie

Welkom bij de ontwikkelaarsdocumentatie van Pluvo. Hier vind je technische uitleg, voorbeelden en GraphQL-definities voor het integreren met de Pluvo API. Elk document bevat praktische voorbeelden, typebeschrijvingen en mutatievoorbeelden gebaseerd op het actuele schema.

Introductie

De Pluvo API is een GraphQL-interface voor het beheren van gebruikers, trainingen en evenementen, met authenticatie via OAuth-token. Het ondersteunt real-time updates via webhooks en biedt toegang tot verschillende scopes voor gebruikersbeheer, trainingen en evenementen.

Getting Started

API-verzoeken verlopen via GraphQL met vereiste authenticatie door een geldig OAuth-token. Stel de headers in en gebruik de juiste endpoint-URL. Tokens moeten automatisch worden vernieuwd en er zijn standaard rate limits van toepassing. Testen kan met een eigen organisatieomgeving.

Concepten & Architectuur

Pluvo's API-documentatie beschrijft kernconcepten zoals gebruikers, groepen, leerlijnen en inschrijvingen, evenals de architectuur van de GraphQL API met kenmerken zoals één endpoint en HMAC-beveiliging. Aanbevolen patronen omvatten robuuste synchronisatie en archivering in plaats van verwijderen.

Users

Gebruikers kunnen worden opgehaald, aangemaakt, bijgewerkt of gearchiveerd via GraphQL. Belangrijke mutaties zijn createUser, updateUser, en archiveUsers. Gebruik updateOrCreateUser voor efficiëntie en om dubbele logica te vermijden. Er is geen mogelijkheid om gebruikers permanent te verwijderen.

Groups

Beheer groepen met GraphQL: haal groepen op, maak nieuwe groepen aan, update of verwijder groepen, en gebruik ref of id voor specifieke selecties. Gebruik paginatedGroups voor uitgebreide filtering en sortering.

Group User & Manager

Gebruikers en managers kunnen worden toegevoegd of verwijderd uit groepen via GraphQL-mutatietypen. De reacties geven informatie over succesvolle en mislukte bewerkingen, met UUID's voor identificatie van gebruikers en groepen.

Training / Leerlijnen

In Pluvo wordt een leerlijn aangeduid als Training in de GraphQL API, met functies voor het ophalen, aanmaken, bijwerken en archiveren van trainingen. Belangrijke queries en mutaties zijn beschikbaar voor het beheren van trainingsgegevens en metadata.

Offer

Een Offer in Pluvo biedt deelnemers de mogelijkheid om zich in te schrijven via OfferEvents. Het bevat functies zoals het ophalen, aanmaken, bijwerken en archiveren van aanbiedingen, met GraphQL-queries en -mutaties voor beheer. Een Offer is niet direct inschrijfbaar; inschrijving gebeurt via gekoppelde events.

OfferEvent & Date

Een OfferEvent is een inschrijfmoment voor een aanbod, met meerdere datums en gekoppelde content. Gebruikers kunnen evenementen aanmaken, bijwerken, archiveren en datums toevoegen via GraphQL-mutatietaal. Elk evenement kan meerdere datums bevatten en inschrijvingen gebeuren op het niveau van het OfferEvent.

Enrollments

Inschrijvingen voor events verlopen via een OfferEvent, waarbij gebruikers zich kunnen inschrijven, uitschrijven en hun inschrijvingsstatus kunnen controleren met GraphQL-queries en -mutaties. Statussen omvatten ENROLLED, WAITLISTED, CANCELLED en DECLINED.

Portfolioitems

Portfolio-items zijn prestaties van gebruikers die handmatig of automatisch kunnen worden toegevoegd, met mogelijkheden om items op te halen, aan te maken, bij te werken en te verwijderen via GraphQL. Elk item bevat een titel, beschrijving, datums en bijlagen.

PortfolioReport

De portfolioReport query biedt geavanceerde filtering van portfolio-items op type, score en voortgang. Voorbeelden van queries zijn onder andere het ophalen van certificaten, gebruikers met scores boven een drempel en voltooide leerlijnen per groep. Gebruik verschillende parameters voor gerichte resultaten.

Certificate

Certificaten worden automatisch uitgegeven aan gebruikers na het voltooien van trainingen, met gebruik van GraphQL queries en mutaties om certificaten op te halen en toe te kennen. Gebruik uitsluitend de generateCertificate mutatie voor uitgifte, en certificaten verschijnen automatisch in het gebruikersportfolio.

Webhooks

Pluvo ondersteunt webhooks voor notificaties bij belangrijke gebeurtenissen zoals trainingen en gebruikerswijzigingen, met beveiliging via handtekeningverificatie. Voor elke gebeurtenis zoals training, gebruiker, groep en portfolio-item zijn specifieke JSON-payloads beschikbaar.

Sluit melding

Pluvo maakt leertrajecten gemeente Den Haag eenvoudig - Klantverhaal

Online academie voor medezeggenschapsraden

Vijf goede redenen om je opleidingen intern te regelen