Het gebruik van de REST API is gratis tot 20.000 calls per maand (240.000 calls per kalenderjaar). Daarboven betaal je een bedrag naar rato van het aantal aanroepen dat via de REST API wordt uitgevoerd. Op deze pagina wordt uitgelegd hoe je het aantal REST API-calls op je omgeving kunt monitoren.
Welke REST API’s heb ik in gebruik?
In de productieomgeving kun je in de functie Interfaces (MINTFA) zien welke REST-API’s er in je omgeving in gebruik zijn.
Hoeveel REST API-calls vinden er plaats?
Selecteer een REST-API en klik op de shortcut Performancelogging per dag. In dit scherm kun je zien hoeveel calls/acties er per dag voor de geselecteerde REST API zijn gedaan.
Via het Freeform-filter kun je het aantal calls vanaf een bepaalde datum tellen, bijvoorbeeld vanaf 1 januari 2022. Neem hiervoor in het veld Freeform de waarde ai12.datum > 31/12/2021 op. Dan krijg je alle acties per dag te zien vanaf 1 januari 2022. Als je het totaal aantal calls wilt tellen, kun je de lijst het beste even naar Excel exporteren.
Als je het REST API-gebruik al gedurende een jaar wilt monitoren, dan kun je op dezelfde manier filteren op het aantal REST API-calls vanaf de vorige maand of vanaf het vorige kwartaal.
Wat is mijn totaalverbruik per maand, kwartaal of jaar?
Maak je van meer dan één REST-API gebruik, dan voer je bovengenoemde actie voor elke REST-API uit. Daarna tel je alle totaalacties van de REST-API’s bij elkaar op om tot het totaalverbruik per maand, kwartaal of jaar te komen (afhankelijk van de gekozen selectie). Dit aantal is dan het totaalverbruik van je omgeving.
Welke calls doet de REST API?
Wil je meer inzicht in de calls die via de REST API specifiek worden uitgevoerd? Vanuit de functie Interfaces (MINTFA) kun je via de shortcut Performancelogging acties hierop inzoomen. Standaard worden in dit scherm de REST API-acties van de datum van vandaag getoond. Via het filter kun je de datum-selectie aanpassen. Zo kun je zien welke specifieke calls er op die dag(en) gedaan zijn.
Goed om te weten: De gegevens van de uitgevoerde acties blijven ca. 4 weken bewaard. Je kunt dus maximaal een maand terugkijken.
Spreiding calls per dag
In je omgeving zijn een aantal standaard performance rapportages aanwezig, ook voor de REST API. Deze vind je in de functie Pagina’s (MPAGIN) met de naam Performancestatistieken AllSolutions. Open deze pagina (via de actie Pagina tonen rechts in het scherm) en scroll naar beneden naar de rapportages voor de REST API.
Via het ‘ververs’ knopje links bovenaan de rapportage kun je de rapportages laten bijwerken met de actuele gegevens van gisteren en vandaag. Het is handig om dit bijvoorbeeld aan het einde van de dag te doen, zodat je een goede vergelijking met de dag daarvoor (linker rapportage) kunt maken.
Deze rapportages geven je inzicht in de spreiding van het aantal REST API-calls over de dag. Op basis hiervan kun je wellicht besluiten om de REST API-calls buiten kantoortijden minder frequent of slechts beperkt te laten uitvoeren.
Eigen rapportage in functie ‘Interfaces’
Eventueel kun je zelf een eigen rapportage maken in de functie Interfaces (MINTFA) die het aantal REST API-calls op je omgeving laat zien. Maak hiervoor eerst een aparte configuratiegroep ‘rap’ voor ‘rapportages aan (als deze nog niet aanwezig is in je omgeving).
- Maak een nieuwe weergaveset voor configuratiegroep ‘rap’.
- Kopieer de eerste weergave op Interfacecode naar een nieuwe weergave voor de REST API calls.
- Voer als Extra conditie standaardtabellen de waarde ‘ai01{ai01.methode = “R”}‘ in.
- Voeg bij de Gekoppelde tabellen de tabel ‘ai12’ toe.
- Gebruik als conditie voor de koppeling bijvoorbeeld:
each ai12 where ai12.if-cd = ai01.if-cd and (ai12.datum >= 01/01/2022 and ai12.datum <= 31/12/2022) - In de weergave neem je als kolommen in ieder geval de velden Datum (ai12.datum) en Aantal acties (ai12.aant) op.
- Op deze weergave kun je daarna een gestapelde staafgrafiek rapportage maken die per maand het aantal REST API calls laat zien, eventueel verdeeld over de verschillende REST API’s (als er meerdere API’s in je omgeving in gebruik zijn).
- Neem bij de rapportage in ieder geval ook een datalijst op, zodat je straks bij de snapshot ook deze datalijst met de absolute aantallen kunt openklikken.