Abrechnung für die ConverterAPI

Einleitung

Wird in Stella die ConvertAPI (https://www.convertapi.com/) benutzt, ist es ratsam, die sogenannte Billing API einzurichten, um Informationen zur Nutzung zu ermitteln.

Einrichtung

Rufen Sie die ConvertAPI Seite auf und loggen Sie sich ein bzw. melden Sie sich an. Im Kundenbereich findet man dann die Menüpunkte, um alle benötigten IDs und Keys zu ermitteln:

Es werden folgende Daten benötigt, um diese in die Stella Helper Konfiguration einzutragen:

• Secret Key
• API Token

Den Secret Key finden man im Bereich Secret Key. Hier kann dieser auch erneuert werden bei Bedarf. Vergessen Sie dann nicht, diesen Key auch in der Konfiguration zu ändern.

Den API Token kann man beliebig oft anlegen, in der Regel tut man dies pro Mandant bzw. Kunde. API Tokens haben eine Laufzeit, i.d.R. 10 Jahre. Wird ein Token kompromittiert, kann dieser auch gelöscht und neu erzeugt werden.

In der Konfiguration muss zudem noch gewählt werden, welchen Dienst man nutzen möchte. Verfügbar sind die Optionen EU und Non-EU.

Nutzung abfragen

Best practise ist die Nutzung eines periodischen Scripts in Stella. Dies ist ein Beispiel:

var Billing = {
  URL: API.getConfigValue("helper", "URL"),
  USERNAME: API.getConfigValue("helper", "Domino Username"),
  PASSWORD: API.getConfigValue("helper", "Domino Password"),
  pullData: function(){
    var result = API.rest(this.URL + '/billingConvertAPI', this.USERNAME, this.PASSWORD);
    API.log().forceToBackend().info(result);
  }
}
Billing.pullData();

Sinn und Zweck ist es, dieses Script mindestens 1x täglich laufen zu lassen. Das sammelt alle Daten zum aktuellen Monat. Möchte man explizit einen anderen Monat/ein anderes Jahr einlesen, so kann dies mit den URL Parametern in dieser Form erfolgen:

http://localhost/Stella/helper.nsf/index.xsp/billingConvertAPI?month=10&year=2023

Die Reihenfolge der Parameter spielt dabei keine Rolle.

Daten sichten

Die Stella Helper App enthält eine Übersichtsseite (billing_convert.xsp), die sie im Browser öffnen können: