Automatisierung der Dateneingabe von KPIs mit RESTFul API

Automatisches Lesen und Schreiben von Daten für KPIs mit RESTFull API. Automatisieren Sie den Zugriff auf Ihre Daten für Business-Tools von Drittanbietern.

Allgemeine Information

• Dokumentation. Die Dokumentation für die API Anrufe ist hier verfügbar.
• Einschränkungen. API kann nur durch den Besitzer des Kontos verwendet werden. Ein Konto hat ein Limit von 100 API Anrufen pro Stunde pro Power Nutzer.

Erste Schritte

Untenstehend finden Sie einige Anweisungen, die Ihnen zu Beginn helfen werden.

Autorisierungstoken

Bevor Sie API Anrufe übermitteln, muss ein Autorisierungstoken erlangt werden. Senden Sie die folgenden Daten an den Login Endpunkt:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

{

"email" : "hier_mit_Zugangs-E-mail_ersetzen",

"password" : "hier_mit_Zugangs-Passwort_ersetzen"

}

Die Antwort im JSON Format umfasst Fehlermeldung und Token Parameters:

{

"email": "string",

"errorMessage": "string",

"success": true,

"token": "string"

}

Nutzen Sie den erhaltenen Token Parameter im Header aller Anrufe zum API:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

Token: mit_erlangtem_Token_ersetzen

IDs für Scorecard und KPI erhalten

API Anrufe in Bezug auf KPI erfordern die ID der Scorecard und den GUID des KPI.

Erhalt der Scorecard ID

Die Scorecard ID kann durch die Nutzung von API Anruf oder manuell gefunden werden. Zum manuellen Auffinden der Scorecard ID:

1. Gehen Sie zum Bereich "Meine Scorecards"
2. Öffnen Sie die gewünschte Scorecard
3. Die URL der Scorecard sieht in etwa so aus: https://de.webbsc.com/s/123456
4. Die Zahl am Ende ist die ID der Scorecard

Erhalt von KPI GUID

KPI GUID kann durch die Nutzung von API Anruf oder manuell gefunden werden. Zum manuellen Auffinden von GUID:

1. Öffnen Sie die Scorecard
2. Wählen Sie "Tools" > "Indikatorwerte exportieren"
3. Folgen Sie den Schritten um auf die "Vorschau der Exportergebnisse" Seite zu gelangen
4. Die "GUID" Spalte in der Vorschau umfasst den GUID des KPI

Schreiben und Lesen von Werten durch API

Nutzen Sie KPI Wertekontrolleur um Daten für die KPIs zu schreiben und zu lesen.

• Vergessen Sie nicht Token im Header der Anfragen zu nutzen
• Daten sollten im yyyy-MM-dd Format sein (zum Beispiel "2017-06-30")
• Daten werden im JSON Format gesendet und empfangen
• Um die Rufnummern zu optimieren, nutzen Sie Batch Anrufe
• Um gruppierte, kalkulierte oder vererbte Werte zu lesen, nutzen Sie den Gruppierten Wertekontrolleur

Betrachten Sie dasphp Beispiel zur Nutzung von API.