Abrechnung für die HERE Maps API#
Einleitung#
Wird in Stella die HERE Maps API (https://account.here.com/) benutzt, ist es ratsam, die sogenannte Billing API einzurichten, um Informationen zur Nutzung zu ermitteln.
Einrichtung#
Rufen Sie die HERE Maps API Seite auf (https://platform.here.com/portal/) und loggen Sie sich ein bzw. melden Sie sich an. Klicken Sie den Launcher (das Hamburgermenü oben rechts) und klicken Sie auf Access Manager.
Hier muss eine neue App eingerichtet werden. Diese erhält dann eine eindeutige ID. In der Regel geschieht dies pro Mandant bzw. Kunde. Wechseln Sie auf die Detailansicht der App. Dort finden Sie erneut die App ID (Zeile oben unter dem Icon).
Erstellen Sie hier einen neuen API Key Create API Key. Es können beliebig viele API Keys generiert werden.
Für die Nutzung wird ein OAuth Token benötigt. Dieser wird später live ermittelt, erfordert dafür aber ebenfalls ein ID/Key Paar. Wechseln Sie in den App Details auf OAuth 2.0 in der Navigation links. Klicken Sie auf Create credentials. Im Dialog sehen Sie sowohl die Access Key ID als auch das Access Key Secret. Notieren Sie sich beide oder laden Sie diese Daten als .properties-Datei herunter. Das Secret kann später nicht mehr angezeigt werden. Es können bis zu 2 OAuth Credentials erzeugt werden.
Klicken Sie im Launcher nun auf Usage. Auf dieser Seite erhalten Sie die Organization ID, die in der Stella Helper Konfiguration als "HERE Maps Realm ID" bezeichnet wird. Die ID beginnt mit org.
Es werden folgende Daten benötigt, um diese in die Stella Helper Konfiguration einzutragen:
| Stella Helper App | HERE Maps Daten |
|---|---|
| HERE Maps Realm ID | Organization ID |
| HERE Maps API URL Locate | fester Wert, https://geocode.search.hereapi.com/v1/geocode |
| HERE Maps API URL Discover | fester Wert, https://discover.search.hereapi.com/v1/discover |
| HERE Maps URL OAuth | fester Wert, https://account.api.here.com/oauth2/token |
| HERE Maps App ID | App ID |
| HERE Maps API Key | API Key |
| HERE Maps ID | Access Key ID |
| HERE Maps Secret | Access Key Secret |
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 + '/billingHereMaps', 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_heremaps.xsp), die sie im Browser öffnen können:
