Entwicklungsumgebung
Entwicklungsumgebung
API-Testserver
Um Aufrufe an die CareSuite API testen zu können, steht unter folgender Adresse ein Testserver zur Verfügung:
Direkt nach dem ersten Seitenaufruf wird eine persönliche Konsumenten-ID und ein Hash-Secret generiert und angezeigt.
Mit Hilfe dieser beiden Werte können nun Testrufe an die API gesendet werden. Alle Änderungen werden dann direkt im Web-Browser angezeigt.
Als target kann ein beliebiger Wert verwendet werden. Alle übrigen Werte müssen dem definierten Aufbau entsprechen.
Einen Beispiel-Request senden
Ein Beispielrequest könnte so aussehen:
POST /api/v1/visicall
Host: test.api.caresuite.ch
Content-Type: application/json
{
"target": "8F:15:4E:3C:E4:92",
"consumer": "bc326180-8180-11e6-b163-8de1f81601da",
"hash": "177d06684bc8b2ba72c74aff7d76a7d82ef3a0002c070556d426494ddfa83e61",
"data": {
"event": "Hotelruf",
"position": "Haupteingang"
}
}Die Antwort des Servers enthält nützliche Debug-Informationen zur Hash-Generierung. Daraus ersichtlich ist, welches secret verwendet wird, wie der zusammengesetzte string vor dem Hashen aussieht, welcher Hash erwartet wurde hash.expected und welcher Hash mitgesendet wurde hash.provided.
{
"success": false,
"messages": [
{
"code": "invalid_hash",
"status_code": 400,
"errors": "Ungültiger Hash"
}
],
"debug": {
"secret": "YXWOgKGkwKI8OyKsOyxb1PfV1CCAkmBNAbKGRNqMBpiulr0aPaWdxiBTHmFxiYNa",
"string": "8F:15:4E:3C:E4:92.bc326180-8180-11e6-b163-8de1f81601da.{\"event\":\"Hotelruf\",\"position\":\"Haupteingang\"}",
"hash": {
"expected": "f0b9f0134c819f4cc26a058191c4e7cc5d980416be3d17099d4aecc1f2acb781",
"provided": "177d06684bc8b2ba72c74aff7d76a7d82ef3a0002c070556d426494ddfa83e61"
}
}
}