Änderungen

Die CeviDB Cevi.DB bietet eine <abbr>API</abbr>, mit der Personen- und Gruppen-Daten aus der Datenbank ausgelesen werden können. Die <abbr>Datenveränderungen sind über die API</abbr> erlaubte es aber hingegen '''nicht''' Daten in der CeviDB zu verändernmöglich.

=== Allgemeine Hinweisee =OAuth Provider==Die Schnittstelle wird über POST- und GET-Anfragen angesteuert und verwendet [http://deCevi.wikipediaDB kann als OAuth Provider genutzt werden.org/wiki/JavaScript_Object_Notation JSON] als DatenformatDies benötigt allerdings eine Konfiguration seitens Cevi. Der Zugriff über die Schnittstelle erfordert die Zugangsdaten eines registrierten BenutzersDB Steuergruppe. Die Rechte der Schnittstelle entsprechen dann denn Rechten des verwendeten NutzersMelde Dich dafür bei cevidb(at)cevi. Beim Login wird ein <code>user token</code> generiert, das danach bei jeder Anfrage mitgesendet werden mussch.

=== Ablauf einer Abfrage =API Nutzung==# LoginDie REST-Schnittstelle wird über POST- und GET-Anfrage mit eMail Anfragen angesteuert und Passwort senden# Aus Antwort <code>user token<verwendet [http:/code> auslesen# Anfrage für Gruppen- oder Personendaten senden (mit eMail und <code>user token</code>)# Aus Antwort gewünschte Daten auslesen'''Wichtig''': Passwörter dürfen nicht hardcoded im Programmcode hinterlegt werdende. Passwörter im Programmcode sind eine Sicherheitsrisikowikipedia. Soll ein Programm ohne Interaktion mit einem Benutzer ausgeführt werden, so kann das <code>user token<org/wiki/code> im Programmcode hinterlegt werdenJavaScript_Object_Notation JSON] als Datenformat. Gelingt es einem Angreifer das Token auszulesen, so erhält er nur eingeschränkte Lese-Rechte. Ein gestohlenes Passwort würde ihm erlauben, sich mit den vollen Benutzerrechten des Besitzers einzuloggen. Bitte informiert Die offizielle Dokumentation findet ihr auch auf Github: [mailtohttps:cevidb@cevi//github.ch cevidb@cevicom/hitobito/hitobito/blob/master/doc/development/05_rest_api.chmd], wenn ihr ein Skript erstellt und ein <code>user token</code> hinterlegt.

=== Erstes Login ===Um sich anzumelden, muss ein POST-Request an https'''Wichtig'''://dbPasswörter dürfen nicht hardcoded im Programmcode hinterlegt werden.ceviPasswörter im Programmcode sind ein Sicherheitsrisiko.ch/users/sign_in.json gesendet Soll ein Programm ohne Interaktion mit einem Benutzer ausgeführt werden. Als Parameter müssen , so kann das <code>person[email]user token</code> und  im Programmcode hinterlegt werden. Gelingt es einem Angreifer, das Token auszulesen, so erhält er nur eingeschränkte Lese-Rechte. Ein gestohlenes Passwort würde ihm erlauben, sich mit den vollen Benutzerrechten des Besitzers einzuloggen. Bitte informiert cevidb(at)cevi.ch, wenn ihr ein Skript erstellt und ein <code>person[password]user token</code> übergeben werden hinterlegt.

==== Beispiele =Authentifizierung===TODOZur Nutzung der API ist ein Token notwendig. Momentan gibt es zwei Arten von Tokens.

====User-Tokens===='''============== !! User-Token wurden mit dem Update vom 2024-01-09 deaktiviert!! ============== ''' Dies ist ein persönliches Token. Das heisst, es hat den gleichen Zugriff (lesen) wie der Ersteller. Auf lange Sicht wird diese Art eventuell auch wieder abgeschaltet. Das Token erhältst du mit folgendem Request:<syntaxhighlight lang="bash" line="1">wget -O- https://db.cevi.ch/users/sign_in.json --post-data 'person[email]=<YOURUSERNAME>&person[password]=<YOURPASSWORD>'</syntaxhighlight>Das User-Token ist im Property "authentication_token" im JSON der Antwort enthalten. Das Token bleibt konstant und kann daher auch über längere Zeit verwendet werden. Das Token muss bei den Abfragen entweder als Query Parameter (<code><URL>?user_email=<YOURUSERNAME>&user_token=<YOURTOKEN></code>) oder im HTTP Header (bevorzugt da sicherer, <code>X-User-Email: ceviname@cevi.ch, X-User-Token: 123456</code>) übergeben werden. ====Service-Tokens (empfohlen)====Dies ist die neue Art der Authentifizierung. Sie ändern momentan recht schnell, aus diesem Grund verweisen wir hier nur auf die "offizielle" Dokumentation auf Github: [https://github.com/hitobito/hitobito/blob/master/doc/development/07_service_accounts.md]. Das Token kann jeweils von den Abteilungsleitern auf der Ortsgruppe im Reiter Einstellungen mit der Schaltfläche "API-Keys" erstellt werden (<nowiki>https://db.cevi.ch/groups/GRUPPENID/service_tokens</nowiki>). Dabei kann sowohl der Scope (z. B. aktuelle Ebene oder auch darunterliegende) wie auch die Rechte (z. B. Gruppen lesen, Personen lesen, Anlässe lesen, ...) definiert werden. Das Token muss bei den Abfragen jeweils wie folgt übergeben werden: <code><URL>?token=<YOURTOKEN></code>=== Endpunkte ====

!Beispiel (gid=1, pid=2, eid=3)!Hinweise

|Gruppen<code><gid></code>

|<nowiki>https://db.cevi.ch/groups/1.json</nowiki>|

|Personen in Gruppe<code><gid></code>

|<nowiki>https://db.cevi.ch/groups/1/people.json</nowiki>|

|Details zu Person<code><pid></code>

|<nowiki>https://db.cevi.ch/groups/1/people/2.json</nowiki>|Wird versucht ohne Gruppen-Angabe auf eine Person zuzugreifen (<code><nowiki>https://db.cevi.ch/people/</nowiki><pid>.json</code>) so wird die Anfrage auf die Hauptgruppe der Person weitergeleitet. Allerdings wird bei dieser Weiterleitung der Query-String ignoriert, so dass ein <code>401 Authorization Required</code> Fehler resultiert. Aus der Fehlermeldung kann jedoch die korrekte <abbr>URL</abbr> bestimmt werden.|-|Events <code><eid></code>|<nowiki>https://db.cevi.ch/groups/</nowiki><gid>/events/<eid>/participations.json|<nowiki>https://db.cevi.ch/groups/1/events/3/participations.json</nowiki>|Über den Events-Endpunkt können auch die Fragen, welche beim Anlass/Kurs erfasst sind, abgefragt werden. Diese sind im json zu finden.|-|User Token verwalten|https://db.cevi.ch/users/token.json||Bei einem post request wird ein neues erstellt, bei einem delete Request wird das bestehende gelöscht. Als Parameter müssen wie beim Login <code>person[email]</code> und <code>person[password]</code> übergeben werden.

===Beispiele (mit User Tokens)=== ====User Token ermitteln====Python:<syntaxhighlight lang="python" line="line">import requestsemail = "ceviname@cevi.ch"passwort = "123456"res = requests.post('https://db.cevi.ch/users/sign_in.json?person[email]='+email+'&person[password]='+passwort)token = res.json()["people"][0]["authentication_token"]</syntaxhighlight>'''Hinweis: Wichtig'''Wird versucht ohne Gruppen: Damit die https-Verbindung klappt, müssen die CA-Zertifikate verfügbar sein. In Python kann die Zertifikatdatei mit dem verify Keyword-Angabe Argument der post-Funktion definiert werden. ====Daten abfragen====Sobald das Authentication Token bekannt ist, können verschiedene Endpunkte abgefragt werden. Die URL entspricht dabei der URL im Browser, endet aber auf eine Person zuzugreifen <code>.json</code>Bei jeder Abfrage müssen zudem die Email-Adresse und das <code>user token</code> mitgesendet werden. Dazu bestehen zwei Möglichkeiten: *als URL-Parameter: <code>.json?user_email=ceviname@cevi.ch&user_token=123456</code>*als Headers: <code>X-User-Email: ceviname@cevi.ch, X-User-Token: 123456</code> und <code>Accept: application/json</code> Weiter können weitere GET-Parameter (analog zur “richtigen” Cevi.DB) angehängt werden. Am besten führt man das Gewünschte in der Cevi.DB aus (zum Beispiel Sortieren nach Rollen) und kopiert die URL, ändert die Endung zu <code>.json<nowiki/code>. Normale Abfrage mit Python:<syntaxhighlight lang="python" line="1">import requests# vor diesem Teil muss natürlich das Token ausgelesen und gespeichert werdenemail = "ceviname@cevi.ch"token= "1a2b3c"res = requests.post('https://db.cevi.ch/groups/5/people.json?user_email='+email+'&user_token='+token)data = res.json()["people/"]</nowikisyntaxhighlight>Normale Anfrage mit der Shell:<pidsyntaxhighlight lang="bash" line="line">wget --header "X-User-Email: ceviname@cevi.ch" --header "X-User-Token: 1a2b3c" \ --header "Accept: application/json" https://db.cevi.ch/groups/5/people.json -O people.jsoncat people.json</codesyntaxhighlight>) so wird die Anfrage auf mit Sortierung mit Python:<syntaxhighlight lang="python" line="line"># nach Login, Variable token ist definiert# gewünscht ist eine Sortierung nach Rollen# der Teil sort=roles&sort_dir=asc sortiert nun nach den Rollen, die Haubtgruppe der Person weitergeleitethöchste (z.B. Allerdings wird bei dieser Weiterleitung der QueryAL) ist dann auch im json-String ignoriert, so dass ein File zuerst drin.res = requests.get('https://db.cevi.ch/groups/5/people.json?sort=roles&sort_dir=asc&user_email=ceviname@cevi.ch&user_token='+token)data = res.json()['people']<code/syntaxhighlight>401 Authorization RequiredAnfrage mit Rollenauswahl mit Python:</codesyntaxhighlight lang="python" line="1"> Fehler resultiert# nach Login, Variable token ist definiert# gewünscht ist eine Sortierung nach Rollen und eine Auswahl (nur AL)# der Teil sort=roles&sort_dir=asc sortiert nun nach den Rollen. Aus # der Fehlermeldung kann jedoch Teil filters[role][finish_at]=&filters[role][role_type_ids]=35&filters[role][start_at]=&name=&range=deep grenzt die korrekte Rollen ein.res = requests.get('https://db.cevi.ch/groups/5/people.json?filters[role][finish_at]=&filters[role][role_type_ids]=35&filters[role][start_at]=&name=&range=deep&sort=roles&sort_dir=asc&user_email=ceviname@cevi.ch&user_token='+token)data = res.json()['people'] #ist hier leer, da auf der Geschäfsstelle (Gruppe 5) keine Abteilungsleiter erfasst sind.<abbr/syntaxhighlight>URL<==Tools=====Spender-Tool des RV (cevidbtool)===Die API wird vom Spender-Tool des RVs verwendet. Das Tool ist in Python geschrieben und ist freie Software. Es kann von [https://github.com/nchiapol/cevidbtool Github] heruntergeladen werden.===Couvertgenerator (cevi-versand)===Das Tool [https://github.com/lucidBrot/cevi-versand cevi-versand] erstellt nach einmaligem einrichten mit minimalem manuellen Aufwand PDFs um Couverts für den Versand zu drucken. Dafür verwendet es auch die API. Unter anderem kann man damit: *Ein Cevi-Logo auf den Umschlag drucken.*Personen die zusammen wohnen in ein gemeinsames Couvert bringen. Das bedeutet weniger Arbeit beim Verpacken.*Fehlerhafte Einträge in der DB finden - beispielsweise warnt das Tool, wenn jemand in keiner Ortschaft wohnt.*Cevinamen und dazugehörige Stufennamen aufdrucken. Das vereinfacht das verteilen, wenn man nicht alle Empfänger gut kennt.*Aufdrucken wie viele Leiter/Teilnehmer im Umschlag sind. Das vereinfacht das verpacken, wenn man nicht alle Empfänger gut kennt. [https://github.com/lucidBrot/abbr> bestimmt cevi-versand cevi-versand] ist open-source und gratis zu benutzen, aber Spenden werdengeschätzt :)[[Kategorie:Cevi.DB]]