Developer docs

De Pluvo API geeft je programmatische toegang tot je leeromgeving. Beheer gebruikers, groepen, trainingen, inschrijvingen en certificaten vanuit je eigen systemen.

De API is gebaseerd op GraphQL. Je bepaalt zelf welke data je opvraagt of muteert, zonder overbodige velden. Authenticatie verloopt via OAuth 2.0 met client credentials. Webhooks houden je systemen real-time op de hoogte van wijzigingen.

Concept & Architecture

Structure Overview

Welcome to Pluvo's API documentation. The API follows a clear hierarchical structure.

Core Entities

  • Organization: Top-level container (your academy)
  • Users: People in your organization
  • Groups: Collections of users
  • Training: Course content with modules and chapters
  • Offer: Enrollment wrapper for trainings
  • OfferEvent: Concrete instance with dates and capacity
  • Enrollment: User's registration for an event
  • Portfolio: User's progress and achievements

Relationships

Organization → Users → Groups. Training → Offer → OfferEvent → Enrollment. Users earn Portfolio items through training participation.