Automatisierung der Dateneingabe von KPIs mit RESTful API

Automatisches Lesen und Schreiben von Daten für KPIs mit RESTful 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.
• Webhooks. Alerts in BSC Designer können konfiguriert werden, um Webhooks zu versenden.

Erste Schritte

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

Berechtigungs-Token

API-Aufrufe erfordern einen API-Schlüssel oder ein temporäres Autorisierungs-Token.

Um einen neuen API-Schlüssel zu erstellen, folgen Sie diesen Schritten:

1. Gehen Sie zum Einstellungs-Abschnitt
2. Wechseln Sie zur Registerkarte Integrationen
3. Klicken Sie auf die Schaltfläche API-Schlüssel hinzufügen

Benutzen Sie den erhaltenen API-Schlüssel Parameter in den Kopfzeilen aller anderen Aufrufe der API:

POST /rest/login HTTP/1.1

Host: https://www.webbsc.com

Content-Type: application/json

Token: replace_with_obtained_token

Autorisierungstoken

API-Aufrufe erfordern einen API-Schlüssel oder einen vorübergehenden Autorisierungstoken.

Um einen neuen API-Schlüssel zu erstellen, gehen Sie wie folgt vor:

.

1. Zum Abschnitt Einstellungen gehen
2. Gehen Sie zur Registerkarte Integrationen
3. Klicken Sie auf den Button API-Schlüssel hinzufügen

Erhaltenen API-Schlüssel in den Headern aller anderen Aufrufe der API verwenden.

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.