Integrieren von Kaizala-Daten in vorhandene DashboardsIntegrating Kaizala Data to your existing dashboards

Erstellen Sie einen benutzerdefinierten Bericht, oder schließen Sie die Kaizala-Daten mithilfe von Kaizala-APIs an vorhandene Dashboards an.Create custom report or plug your Kaizala data to your existing dashboards using Kaizala APIs.
Als Drittanbieterorganisation-Sie möchten Kaizala-Daten mit Ihrem vorhandenen Dashboard verbinden, können Sie dies auf folgende Weise tun:As a third party organization - You want to plug Kaizala data to your existing dashboard, then you can do it using the following ways:
1. Abrufen von Kaizala-Daten über Power BI-Content Pack und Erstellen eines benutzerdefinierten Berichts auf PowerBI1. Get Kaizala data through Power BI-Content Pack and create a Custom report on PowerBI
2. greifen Sie auf Kaizala-Daten über Connectors zu, und führen Sie das vorhandene Dashboard in dem Format aus, das es versteht.2.Access Kaizala data through connectors and pass on to existing dashboard in the format that it understands. Sie können mit Kaizala Connecters auf Daten zugreifen:You can access data using Kaizala Connecters:

a.APIs -Kaizala Connectors ermöglichen Drittanbieterentwicklern, Kaizala in Ihre Geschäftsprozesse zu integrieren, indem Sie die Möglichkeit bieten, eine kuratierte Reihe von Aktionen in Kaizala mithilfe von Rest-basierten API-aufrufen durchzuführen.a.APIs - Kaizala Connectors enable 3rd party developers to integrate Kaizala into their business processes by providing the ability to perform a curated set of actions in Kaizala using REST based API calls. Der Anwendungsbereich der API ist für externe Systeme zum Aufrufen des Endpunkts und zum Ausführen von Aktionen bei Bedarf.The scope of the API is for external systems to call the end-point and perform actions on-demand. Das heißt, es handelt sich dabei um ein PULL-Modell, bei dem einzelne Endpunkte aufgerufen werden müssen, um bestimmte Aktionen mithilfe der Kaizala-API auszuführen.That is, this will be a PULL model – where individual endpoints need to be called to perform specific actions using Kaizala API's.
b. webhooks – das Push-Modell, mit dem die Kaizala-Plattform Aktionen auslösen kann, können Sie mit webhooks konfigurieren.b.webhooks - The PUSH model where Kaizala platform can trigger actions can be configured using webhooks.

Kaizala-Connectors ermöglichen Drittanbieterentwicklern, Kaizala in Ihre Geschäftsprozesse zu integrieren, indem Sie die Möglichkeit bieten, eine kuratierte Reihe von Aktionen in Kaizala mithilfe von REST-basierten API-aufrufen durchzuführen.Kaizala Connectors enable 3rd party developers to integrate Kaizala into their business processes by providing the ability to perform a curated set of actions in Kaizala using REST based API calls. Der Anwendungsbereich der API ist für externe Systeme zum Aufrufen des Endpunkts und zum Ausführen von Aktionen bei Bedarf.The scope of the API is for external systems to call the end-point and perform actions on-demand. Das heißt, es handelt sich dabei um ein PULL-Modell, bei dem einzelne Endpunkte aufgerufen werden müssen, um bestimmte Aktionen mithilfe von Kaizala- APIsauszuführen.That is, this will be a PULL model – where individual endpoints need to be called to perform specific actions using Kaizala APIs. Das PUSH-Modell, mit dem die Kaizala-Plattform Aktionen auslösen kann, kann mit webhooks konfiguriert werden.The PUSH model where Kaizala platform can trigger actions can be configured using webhooks.

Integration mit webhooks:Integration Using Webhooks:


Dies ist ein PUSH-basierter Mechanismus.This is a PUSH based mechanism. Sobald webhook bei einer bestimmten Aktion registriert ist, sendet der Benutzer bei jeder Übermittlung von Daten zu dieser Aktion auf Kaizala Application-Kaizala Server eine Ereignisbenachrichtigung (HTTP-POST-Nachricht) mit der Antwort Nutzlast (JSON-Format) an den konfigurierten URL-Endpunkt.Once Webhook is registered on particular action, Whenever user submits data on that action on Kaizala Application - Kaizala Server will send a event notification (HTTP POST message) with response payload (JSON Format) to the configured URL endpoint. Sobald Daten am Kunden Endpunkt benachrichtigt werden, sollte die Logik zum Analysieren der Antwort Nutzlast Daten in die entsprechenden Tabellen im Speicher (Datenbank-oder SharePoint-,..) auslösen und in diese einfügen, und Visualisierungen können durch Abfragen von Daten aus dem Speicher erstellt werden.Once data is notified on customers endpoint, Logic for parsing the response payload should trigger and Insert data in to the respective tables in the storage (Database or sharepoint,..) and Visualizations can be built by querying data from the storage. Vorteil ist, dass jede Organisation Kaizala-Daten in Ihre benutzerdefinierten Dashboards einbinden kann, ohne die vorhandenen Arbeitsabläufe zu unterbrechen.Advantage of this is any Organization can get Kaizala data in to their Custom dashboards without disrupting their existing work flows.

Mit dieser Schaltfläche können Sie den oben beschriebenen Prozess einsehen und im Detail anzeigen:Lets drill down in to the above process and see it in detail:

Wie kann ich einen webhook am Endpunkt registrieren?How to register a webhook on endpoint?


Nachdem Sie einen URL-Endpunkt konfiguriert haben, auf dem die Kaizala-Ereignisse benachrichtigt werden sollen, können Sie eine Benachrichtigung für die Gruppe oder eine bestimmte Aktion abonnieren.Once you configure a URL endpoint on which you wanted to notify the Kaizala events, You can subscribe for a notification on the group or a particular action. Sie können die Drittanbieter-Rest-API-Clients wie Postman/Advanced Rest-Client verwenden, um einen webhook zu abonnieren.You can use the 3rd party Rest API clients like Postman/ Advanced Rest Client, etc. to subscribe for a webhook. UnterZeichnung der Registrierung eines webhooks für eine bestimmte Aktion ist unten angegeben:Signature of registering a webhook on particular Action is given below:
Gehen Sie zu KAIZALA-API-Dokumentation!Go to Kaizala API Documentation! und klicken Sie aufand click on the
Gehen Sie die Schritte durch, um die Access Token zu erhalten und eine wekbhook zu registrieren.Go through the steps to get the AccessToken and register a wekbhook.


Da Sie jetzt einen webhook registriert haben, wird Kaizala-Server weiterhin die Ereignisse auf die registrierte URL jedes Mal, wenn Ereignis auftritt.As you have now registered a webhook, Kaizala server will keep notifying the events on the registered URL every time event occurs. Die Ereignis Antwort befindet sich im folgenden JSON-Format:Event response is in the below JSON format:


Beispiel Ereignis Antwort in JSON:Sample Event Response in JSON:
{  
"objectId": "com. Microsoft. kaizala. OrderFormDemo","objectId":"com.microsoft.kaizala.OrderFormDemo",
"ObjectType": "ActionPackage","objectType":"ActionPackage",
"EventType": "ActionResponse","eventType":"ActionResponse",
"Abend": "75609730-f5d2-4f07-XXXX-ccca96dd9e76","eventId":"75609730-f5d2-4f07-XXXX-ccca96dd9e76",
"Data": {   "data":{  
"action-Nr": "eb40446b-3dc7-4e8e-XXXX-44ccc5ae760c","actionId":"eb40446b-3dc7-4e8e-XXXX-44ccc5ae760c",
"actionPackageId": "com. Microsoft. kaizala. OrderFormDemo","actionPackageId":"com.microsoft.kaizala.OrderFormDemo",
"Package-Nr": "com. Microsoft. kaizala. OrderFormDemo","packageId":"com.microsoft.kaizala.OrderFormDemo",
"Group-Nr": "af461a3c-49cf-47cf-XXXX-83b5d348318d","groupId":"af461a3c-49cf-47cf-XXXX-83b5d348318d",
"Antwort-Nr.": "75609730-f5d2-4f07-XXXX-ccca96dd9e76","responseId":"75609730-f5d2-4f07-XXXX-ccca96dd9e76",
"isUpdateResponse": false,"isUpdateResponse":false,
"Responder": "+ 911234567890","responder":"+911234567890",
"responderName": "FooName","responderName":"FooName",
"responderProfilePic": """responderProfilePic":"",
"isAnonymous": false,"isAnonymous":false,
"responseDetails": {   "responseDetails":{  
"responseWithQuestions": [   "responseWithQuestions":[  
{  
"Title": "Händler-Outlet","title":"Retailer Outlet",
"Typ": "SingleOption","type":"SingleOption",
"Optionen": [   "options":[  
{  
"Title": "ABC Trader""title":"ABC Traders"
},
{  
"Title": "BCD-Distributoren""title":"BCD Distributors"
},
{  
"Title": "EFG Wholesale""title":"EFG wholesale"
}
],
"Answer": [   "answer":[  
"ABC Trader""ABC Traders"
]
},
{  
"Title": "Rice 1KG","title":"Rice 1KG",
"Typ": "Numerisch","type":"Numeric",
"Optionen": [   "options":[  
],
"Answer": 1.0"answer":1.0
},
{  
"Title": "Rice 5KG","title":"Rice 5KG",
"Typ": "Numerisch","type":"Numeric",
"Optionen": [   "options":[  
],
"Answer": 2.0"answer":2.0
},
{  
"Title": "gemischter Fruchtsaft 250ml","title":"Mixed Fruit Juice 250ml",
"Typ": "Numerisch","type":"Numeric",
"Optionen": [   "options":[  
],
"Answer": 4.0"answer":4.0
},
{  
"Title": "Location","title":"Location",
"Type": "Location","type":"Location",
"Optionen": ["options":[  


],
"Answer": {   "answer":{  
"lt": 99.1234567,"lt":99.1234567,
"LG": 88.1234567,"lg":88.1234567,
"n": "FooAddress""n":"FooAddress"
}
}
]
}
},
"Context": "alle Daten, die in Callback zurückgegeben werden müssen."context":"Any data which is required to be returned in callback.Aktuelle webhook-Daten können durch Aktualisieren angezeigt werden: https://requestb.in/12786un1?inspect:! Current webhook data can be seen by refreshing:: https://requestb.in/12786un1?inspect!
"fromUser": "+ 911234567890","fromUser":"+911234567890",
"fromUserName": "FooName","fromUserName":"FooName",
"fromUserProfilePic": """fromUserProfilePic":""
}
Auf dem registrierten Endpunkt : Geschäftslogik zum Analysieren der Ereignis Antwort und Einfügen von Daten in die entsprechenden Speichertabellen.On the Registered End Point - Have business logic to parse the event response and insert data in to the respective storage tables. Da Daten jetzt am Ende zur Verfügung stehen, werden Daten aus dem Speicher abgefragt und Visualisierungen auf Ihren vorhandenen Dashboards angezeigt.As data is now available at your end, Query data from storage and show visualizations on your existing dashboards. Mit diesem Ansatz können Sie die Visualisierungen von Kaizala-Daten in vorhandenen Dashboards erstellen.With this approach - You can create the visualizations of Kaizala data on existing dashboards. Bei diesem Ansatz werden die Daten mithilfe des webhook-Endpunkts in Echtzeit benachrichtigt.In this approach you will be getting the data notified in Realtime using the Webhook end point.

Wie kann ich Daten mithilfe der Kaizala-API abrufen?How to PULL data using Kaizala API's?

Wenn Sie Daten aus Kaizala in regelmäßigen Abständen abrufen und Daten im Dashboard aktualisieren möchten, können Sie die Kaizala-API mithilfe von Connectors aufrufen und Daten für das erforderliche Aktionspaket abrufen, um die Daten in das Speicher-und Aktualisierungs Dashboard zu aktualisieren.If you want to Pull data from Kaizala in regular Intervals and update data in the dashboard- then You can call Kaizala API's using Connectors and Pull data for the required Action Package, update data in to the Storage and refresh Dashboard.

Zum Abfragen der Antworten eines Aktionspakets-Sie können die API-Signatur und die Antwort sehen, indem Sie zur oben erwähnten Postman-Auflistung wechseln und zur Inhaltsabfrage-API--> FETCH Action Response in a Group und replace with your Group, Action PaketdetailsFor Querying the responses of an Action Package- You can see the API signature and the response by Going to the Postman collection mentioned above and go to Content Query API's--> Fetch action responses in a group and replace with your group, action package details