RESTful API: Vorstellung
-
Hey, vielen Dank für das Bereitstellen der API.
Ich wurde von meiner Gemeinde angefragt, ob ich ein kleines Desktop-Tool schreiben kann, dass die Gottesdienstbesucher in ChurchTools einträgt ohne sich im Webportal einloggen zu müssen. Ist schon absehbar wann diese Funktionalität implementiert sein wird?
Vielen Dank!
-
@philipptrenz sagte in RESTful API: Vorstellung:
Hey, vielen Dank für das Bereitstellen der API.
Ich wurde von meiner Gemeinde angefragt, ob ich ein kleines Desktop-Tool schreiben kann, dass die Gottesdienstbesucher in ChurchTools einträgt ohne sich im Webportal einloggen zu müssen. Ist schon absehbar wann diese Funktionalität implementiert sein wird?
Vielen Dank!
Du meinst sicherlich die Fakten im Events Modul, oder? Nein darüber haben wir aktuell noch nicht gesprochen.
-
@hbuerger Genau! Okay, aber ist der Events-Endpoint schon in Planung? Nachdem die Facts ja frei konfigurierbar sind würde ich für den Endpunkt einfach ein Array mit Key-Values zum Lesen und Setzen vorschlagen.
In etwa so
GET /events/{id}/facts Returns: { "data": [ { "key": "Besucherzahl", "value": 57 }, { "key": "Kollekte", "value": 0 } ] }
und
PUT /events/{id}/facts Request body: { "data": [ { "key": "Besucherzahl", "value": 57 }, { "key": "Kollekte", "value": 165 } ] }
Das sollte generisch genug sein, um auch spätere Erweiterungen an den Facts abbilden zu können.
Ich fände es klasse, wenn das Feature zeitnah Einzug erhält. Ich habe nämlich wenig Lust mich mit der alten API herumzuschlagen
Btw: Wird es eine veröffentlichte Swagger-Spezifikation für die API geben, um sich mit Swagger CodeGen den Client-Code generieren lassen zu können?
-
@philipptrenz sagte in RESTful API: Vorstellung:
Btw: Wird es eine veröffentlichte Swagger-Spezifikation für die API geben, um sich mit Swagger CodeGen den Client-Code generieren lassen zu können?
Diese Spezifikation gibt es schon. Eine Nutzung davon siehst du wenn du /api bei euch in der Installation aufrufst.
Die spezifikation findest du unterhttps://$DEINE_GEMEINDE.church.tools/system/runtime/swagger/openapi.json
$DEINE_GEMEInDE
musst du natürlich austauschen. -
@davidschilling Perfekt, den Link zur JSON-Spezifikation hab ich gesucht. Danke dir!
-
Hi @hbuerger. Vielen Dank für die API, bin gerade drauf gestoßen und finde sie super Hilfreicht!
Ich habe eine kurze frage zur Erweiterung. Ich habe es geschafft meine Gemeinde dazu zu überreden das wir unsere Lieder Datenbank in die Cloud zu ChurchTools ziehen.
Die Song api kann ja aber zur Zeit nur lesen. Habt ihr euch auch überlegt API's zum erstellen von Songs, und für das automatisierte hochlanden von z.b. songbeamer sng dateien zu ermöglichen?
Das wäre super Hilfreich.
Danke.
-
@markusfriesen Du kannst jenseits der dokumentierten RESTful API auch die alte API nutzen. Die musst du halt ein bisschen ausforschen, im Browser die Entwicklertools aufmachen, einen Song hochladen und im Netzwerktab schauen, was da läuft.
-
@bwl21 wobei du die alte API nur für das erstellen der Songs bräuchtest. Für die Dateien gibt es eine eigene file-API bei der du den domaintype song angeben kannst
-
@jziegeler danke für den Hinweis, das ist natürlich richtig.
-
@bwl21 Stimmt, das funktioniert natürlich auch. Probiere ich aus. Danke.