Met de API van Sensus BPM Online kunt u uw eigen applicaties integreren en communiceren met uw projecten. Deze functionaliteit is beschikbaar voor klanten met een Plus-licentie.
Mogelijkheden van de API:
- Lees gegevens van projecten en projectversies.
- Lees gegevens van alle elementen binnen een projectversie.
- Lees alle sjablooninformatie van elementen.
- Voeg nieuwe categoriegroepen en items toe.
- Voeg beperkte sjablooninformatie toe aan elementen.
GraphQL: De basis van de API
Onze API maakt gebruik van de GraphQL-standaard, wat zorgt voor een efficiënte en flexibele manier van data-uitwisseling.
- De API is volledig beschreven in een type-systeem.
- De API is zelf-documenterend.
- U heeft slechts één endpoint nodig. U bepaalt zelf welke informatie u ophaalt, wat overbodige data voorkomt.
- U kunt gebruikmaken van uitgebreide tooling, zoals GraphiQL.
Voor meer diepgaande informatie over GraphQL kunt u terecht op de
Toegang tot de API
Toegang tot de API is beveiligd met een JSON Web Token (JWT) dat hoort bij een specifieke Service User. Dit garandeert dat alleen geautoriseerde aanroepen worden verwerkt. Voor meer informatie over het aanmaken en beheren van Service Users, zie de handleiding over
Verbinding maken met de API
Om een verbinding te maken met de GraphQL API heeft u een geldig JWT nodig. Het endpoint voor uw API is afhankelijk van de URL van uw Designer applicatie.
- Als uw Designer URL is:
https://[klantnaam].sensus-designer.com - Dan is uw GraphQL endpoint:
https://[klantnaam]-server.sensus-designer.com/graphql
Een verzoek versturen
U verstuurt een verzoek naar de API middels een POST-request met de volgende parameters:
De velden operationName en variables zijn optioneel.
Voor meer informatie over het aanroepen van een GraphQL API kunt u de
Voorbeelden en meer informatie
Op onze openbare GitHub-repository vindt u uitgewerkte voorbeelden voor verschillende gebruikssituaties. Deze voorbeelden helpen u direct aan de slag te gaan.
GitHub Repository: