Platform
API-clients beheren
Onder API-clients maak en beheer je de OAuth2-credentials waarmee je kassasystemen en integraties de Puntjes API aanspreken.
De lijst met clients
Ga in de zijbalk naar API-clients. Die pagina toont:
- Aantal clients tegenover je limiet: hoeveel clients je al hebt, en hoeveel je plan er toelaat
- Tabel: elke client met zijn label, client ID, standaardvestiging, status (Actief/Ingetrokken) en aanmaakdatum
Zit je aan je limiet, dan is de knop API-client aanmaken uitgeschakeld en staat er een waarschuwing bij.
Een client aanmaken
Klik op API-client aanmaken en geef de nieuwe client een label (bv. "Kassa vooraan", "Webshop").
Puntjes toont het client secret daarna één keer, in een venster met een kopieerknop. Kopieer het meteen. Sluit je dat venster, dan krijg je het secret niet meer te zien.
Kopieer het secret meteen
Je ziet het client secret alleen op het moment dat je de client aanmaakt. Ben je het kwijt, dan moet je een nieuw secret genereren, en het vorige werkt vanaf dan niet meer.
Wat je met een client kunt doen
Standaardvestiging instellen
Kies een vestiging in de kolom Standaardvestiging. Een transactie die op deze client binnenkomt zonder branch in de payload wordt dan op die vestiging geboekt in plaats van zonder vestiging te blijven. Noemt de payload zelf een vestiging, dan wint die altijd.
Kies Geen standaardvestiging om dit ongedaan te maken. Al geboekte transacties houden de vestiging waarop ze staan.
Een gesloten vestiging valt niet terug
Deactiveer je een vestiging waar een client nog naar terugvalt, dan worden transacties zonder branch geweigerd met
BRANCH_INACTIVE (422) in plaats van zonder vestiging geboekt. Wijs de client eerst een andere vestiging toe.
Secret tonen
Klik op het oogpictogram om het secret van een bestaande client te bekijken. Je bevestigt eerst je wachtwoord. Daarna staat het secret in een venster met een kopieerknop.
Secret opnieuw genereren
Is een secret uitgelekt of kwijt, klik dan op Secret opnieuw genereren. Ook hier bevestig je eerst je wachtwoord. Het oude secret vervalt op slag, en elke integratie die het gebruikt ligt stil tot je ze het nieuwe secret geeft.
Client intrekken
Klik op Intrekken en bevestig om een client definitief uit te schakelen. Een ingetrokken client kan niet meer authenticeren, en de tokens die hij al had werken niet meer. Dit kun je niet terugdraaien.
Best practices
- Eén client per integratie: geef elke kassa en elke dienst een eigen client, zodat je achteraf ziet waar iets vandaan kwam en je er één kunt intrekken zonder de rest stil te leggen
- Label duidelijk: schrijf in het label welk systeem erachter zit, zodat je later niet moet raden
- Ververs secrets periodiek: genereer ze op een vast ritme opnieuw
- Trek meteen in: gaat een terminal uit dienst of is een secret uitgelekt, trek de client dan meteen in
In Authenticatie staat hoe je met die client credentials een access token ophaalt.