Verbruik-API

Verbruik-API is een hulpprogramma-API waarmee je jouw gebruikte Altum-credits kunt bijhouden.

De Verbruik-API geeft je inzicht in je API-gebruik: het aantal calls dat je per API hebt gemaakt binnen een gekozen periode. Handig om je verbruik te monitoren, integraties te controleren en call-gebaseerde checks in te richten.

Let op: aantal calls, geen credits De Verbruik-API rapporteert het aantal calls per API, niet het aantal verbruikte credits of je resterende tegoed. In het creditmodel kost elke API een eigen aantal credits per call. Wil je van calls naar credits: vermenigvuldig het aantal calls met het credittarief van de betreffende API. Zie Credittarieven.

Naamswijziging: van Credit API naar Verbruik-API

Deze API heette voorheen de Credit API. Omdat “credit” in het nieuwe platform een afrekeneenheid is (1 credit = € 0,05) en deze API juist het aantal calls teruggeeft, hebben we de naam verduidelijkt naar Verbruik-API.

Het endpoint zelf verandert niet. Het pad /credit blijft ongewijzigd en volledig ondersteund werken, zodat bestaande integraties, inclusief Enterprise-checks, zonder aanpassing blijven functioneren. Je hoeft niets te wijzigen.

Een GET-verzoek

Een GET-verzoek aan de Verbruik-API retourneert een JSON-antwoord met jouw API gebruik per API voor het opgegeven aantal uren. Door een tijdparameter toe te voegen, kunt u het tijdsbereik van het verzoek in uren opgeven.

Er zit een latentieperiode van 60 seconden tussen wijzigingen in uw tegoed en de aanwezigheid ervan in de Verbruik-API.

Dien een GET-verzoek in bij de API om uw gebruikte API verbruik te ontvangen. Geef uw tijdsbereik op met de tijdqueryparameter

GET https://api.altum.ai/credit

Query Parameters

Name	Type	Description
time	integer	Tijdbereik in uren. Bijv. 24

Headers

Name	Type	Description
x-api-key*	string	Geldige API-sleutel
Content-Type	string	application/json

200: OK succesvol

{ "interactivereference-api": "6", "rebuildapi": "1", "objectdataapi": "1" }

403: Forbidden

{ "message": "Forbidden" }

Sample Request

https://api.altum.ai/credit
?time=40

Sample Response

{
	"interactivereference-api": 1307,
	"avmapi": 671,
	"wozapi": 209,
	"sustainabilityapi": 85,
	"energylabelapi": 390
}