Introductie

GraphQL-interface

  • De Pluvo API is een GraphQL-gebaseerde interface voor het beheren van gebruikers, trainingen, events en meer.
  • Authenticatie verloopt via een OAuth-token op basis van client_id en client_secret.
  • Webhooks bieden real-time updates over o.a. inschrijvingen en statussen.
  • Endpoint: https://[organisatie].pluvo.com/graphql/

De Pluvo API stelt externe systemen zoals HRM-platformen, LMS'en en integratietools in staat om programmatisch te communiceren met het Pluvo-platform.

Voor wie is de API bedoeld?

Authenticatie

Toegang tot de API vereist een OAuth-token dat je aanvraagt via:


POST https://[organisatie].pluvo.com/oauth/token/

Belangrijk:

  • Eindpunt vereist trailing slash /
  • Headers: Content-Type: application/x-www-form-urlencoded
  • Body parameters: Een geldig token wordt meegegeven als Bearer-token in API-requests:

Authorization: Bearer <your_token>

Scopes en toegangsniveaus

API Endpoint

Alle verzoeken worden gedaan naar:


https://[organisatie].pluvo.com/graphql/

Let op: ook hier is de afsluitende slash verplicht.

GraphQL: kort overzicht

De API is volledig gebaseerd op GraphQL.

Je bepaalt zelf welke velden je ophaalt of bijwerkt, wat zorgt voor minimale payloads en maximale flexibiliteit.

Voorbeeldquery:


query user($ref: String!) {
  user(ref: $ref) {
    ref
    name
    email
    isActive
  }
}

De ref fungeert als unieke identifier binnen je eigen systeem.

Je mag zelf deze waarde bepalen bij het aanmaken van een object, zolang hij uniek blijft binnen de entiteit.

Webhooks

Pluvo ondersteunt webhooks voor realtime notificaties over bijvoorbeeld:

  • Nieuwe inschrijvingen
  • Voltooide sessies
  • Wijzigingen in gebruikersstatus Webhook-configuratie gebeurt via de admininterface van de Pluvo-omgeving van je organisatie.

Elk webhook-verzoek bevat een HMAC-handtekening voor verificatie.

Sluit melding