Rocket

De documentatie

De werkbank Documentatie beschrijft de Rocket-API. Alles in Rocket gaat via één GraphQL-gateway; alleen inloggen en tokens zijn REST-routes van de accounts-service. De documentatie wordt gemaakt uit de schema's van de draaiende services, dus hij loopt nooit achter.

Introductie

Kies Introductie voor het overzicht: de adressen van de gateway en de accounts-service in jouw omgeving, en de drie dingen die je nodig hebt voor je eerste aanroep.

De Introductie: de endpoints van gateway en accounts, en hoe je authenticeert

Zo doe je je eerste aanroep:

  1. Haal een Rocket-token. Wissel het token van je identity provider in voor een Rocket-toegangstoken, voor het bedrijf (de tenant) waarin je werkt. De Introductie toont de aanroep als cURL; met Kopiëren neem je hem over.
  2. Stuur je query. Doe een POST naar de gateway met de query en zijn variabelen als JSON, en het Rocket-token in de Authorization-header.
  3. Vernieuw op tijd. Een token verloopt. Vernieuw het met zijn refresh-token, zoals de Introductie laat zien.

Een lijst-query geeft altijd een pagina terug (items, total, page, size) en krijgt zijn filters en sortering in het query-argument.

Referentie

Onder GraphQL-API › Referentie staat elke query en mutation, per domein: Accounts, Contacts, Quotations, Invoices, en zo verder. Het getal achter een domein is het aantal operaties.

  1. Kies links een domein, of zoek met Zoek een operatie of type.
  2. Per operatie zie je de argumenten (met Verplicht waar dat zo is), wat hij teruggeeft en een voorbeeld.
  3. Wissel bij het voorbeeld tussen GraphQL en cURL, en neem het over met Kopiëren.

De Referentie: links de domeinen met hun aantal operaties, rechts getAccount met argumenten en een voorbeeld

Onder elk domein staat ook Types: de velden van elk type, met hun omschrijving.

Authenticatie

Onder REST-API › Authenticatie staan de routes van de accounts-service, die je rechtstreeks aanroept, buiten de gateway om: tokens ophalen en vernieuwen, de publieke sleutels (/.well-known/jwks.json) en het token voor een workload die namens een account werkt. Per route zie je of hij een token vraagt, de antwoorden en een cURL-voorbeeld.

De Authenticatie: de JWKS-route en het gedelegeerde token, elk met een cURL-voorbeeld

Goed om te weten

  • Adressen per omgeving. De voorbeelden gebruiken de adressen van de omgeving waarin je het portaal opent. Kopieer je een voorbeeld van test naar productie, pas dan het adres aan.
  • Rechten. Wat een aanroep teruggeeft, hangt af van de rol van het account achter het token. Krijg je een lege lijst of een weigering, kijk dan eerst naar de rol.