API

Voor klanten met een Plus licentie is mogelijk om toegang te krijgen tot de API van Sensus BPM Online. Middels deze API is het volgende mogelijk:

  • Toegang tot de informatie van projecten en project versies
  • Toegang tot de informatie van alle elementen binnen een versie
  • Toegang tot alle sjablooninformatie van alle elementen
  • Het toevoegen van categorie groepen en items
  • Het toevoegen van beperkte sjablooninformatie aan elementen

GraphQL

De API implementeert de GraphQL standaard, wat inhoudt dat:

  • De API is volledig beschreven in een type-system
  • De API is zelfdocumenterend
  • Er is maar 1 endpoint voor de API en de client kan zelf bepalen welke informatie exact opgehaald dient te worden
  • Uitgebreide tooling beschikbaar. Bijvoorbeeld GraphiQL.

Voor meer informatie over GraphQL verwijzen we u door naar de website van de GraphQL standaard

Testen van de API

Het is mogelijk om te kijken wat de API te bieden heeft middels de geïntegreerde GraphiQL omgeving in de Sensus Designer. Gaat u daarvoor naar het Integraties menu in de Designer en navigeer naar de API.

Als u een Plus licentie heeft kunt u op Open GraphiQL drukken waarna het GraphiQL opent met de juiste variabelen ingesteld voor het huidige project.

Toegang tot de API

Toegang tot de API kan alleen middels een JSON Web Token, welke behoort bij een Service User. Voor meer informatie over Service Users verwijzen we u door naar Service User (JWT).

Verbinden met de API

Als u verbinding wilt maken met de GraphQL API dient u een valide JWT te hebben.

Het endpoint voor de API kunt u achterhalen aan de hand van de URL van uw Designer applicatie:

Is uw Designer URL https://[klantnaam].sensus-designer.com, dan is het GraphQL endpoint: https://[klantnaam]-server.sensus-designer.com/graphql 

Request middels een POST request

Om een request naar de API te maken doet u een POST request met de volgende parameters:

  “query”: “QUERY”,

  “operationName”: “OPERATION_NAME”, //optional

  “variables”: “VARIABLES” // optional

}

 

Meer informatie over het aanroepen van een GraphQL API kunt u vinden op de website van GraphQL.

Voorbeelden

Er zijn uitgewerkte voorbeelden van verschillende use-cases op onze openbare GitHub repository met API voorbeelden:

https://github.com/Sensus-Software/API-Samples

 

Gerelateerde artikelen