====== offer-cube Entwickler Webservice Dokumentation ======

Zurück zur [[offer-cube:webservice|Webservice Dokumentation Startseite]]

====== Modul users ======

Jedes Modul bietet einige Basis-Operationen. Siehe [[offer-cube:webservice|Webservice Dokumentation Startseite]].

^ action    ^  Beschreibung     ^
| login     |  User Login       |
| logut     |  User Logout      |

====== users/login ======

Einloggen mit Benutzername (=Email Adresse) und Passwort.

Im Erfolgsfall wird eine gültige Session ID zurückgeliefert.
Diese SID ist später für jeden weiteren Aufruf notwendig (siehe Beispiel logout)

==== GET ====

https://server/tenant/s/users/login/

==== POST ====

^ Parameter    ^ Beschreibung    ^
| username     | Benutzername (üblicherweise Email Adresse) |
| password     | Passwort |

==== RETURN ====

Der Parameter sid beinhaltet die gültige Session ID, die für jede weitere Aktion benötigt wird.

Beispiel: 
<code javascript>
{"module":"users","error":0,"loggedin":true,"sid":"9bd3b5f93692e4659632c8585eb35447","userinfo":{"id":"1","username":"admin@domain.tld","accesstype":"1024","status":"0","data":"b:0;","tenant":"0","lastname":"Tester","firstname":"Chuck","email":"admin@domain.tld","tel":"+436646285463","location_string":null,"location":"0","location_street":"","location_city":"","location_zip":"0","location_country":"","tenant_name":null,"logintime":1428168110,"ip":"127.0.1.1","token":"2938d72d41179950b9c8d3abd3076207","sid":"9bd3b5f93692e4659632c8585eb35447","lastupdate":1428168110,"validuntil":1428196910,"s_id":49235,"at_superadmin":false,"at_admin":true,"at_backoffice":false,"at_sales":false,"at_technician":false,"at_guest":false}}
</code>

====== Session ID sid verwenden ======

return: 
<code>{"module":"users","error":0,"loggedin":true,"sid":"1f727f5f311981a30d5aeb34c9475833","userinfo": ....}</code>

Die zurückgegebene Session ID "**sid**" (z.B. //1f727f5f311981a30d5aeb34c9475833//) kann nun auf folgende Arten verwendet werden:

   * im GET Request als ?sid=<sid>
   * im POST Request als _sid=<sid>
   * im Header als Authorization: Basic <Base64(sid)>

===== Beispiel sid mit GET =====

Im GET request mit "?sid=..." z.B. **?sid=1f727f5f311981a30d5aeb34c9475833**
<code>curl https://server/tenant/s/customer/list/?sid=1f727f5f311981a30d5aeb34c9475833</code>

===== Beispiel _sid mit POST =====

Im POST request als "_sid=..." z.B. **_sid=1f727f5f311981a30d5aeb34c9475833**
<code>curl https://server/tenant/s/customer/list --data "_sid=1f727f5f311981a30d5aeb34c9475833"</code>

===== Beispiel Authorization Header =====

Im Header als Base 64 encoded **Authorization: Basic <Base64Encoded sid>**
<code>curl https://server/tenant/s/customer/list -H "Authorization: Basic MWY3MjdmNWYzMTE5ODFhMzBkNWFlYjM0Yzk0NzU4MzM="</code>


====== users/logout ======

Ausloggen: Invalidieren einer Session ID.

==== GET ====

https://server/tenant/s/users/logout/?sid=sessionID

Beispiel:

https://server/tenant/s/users/logout/?sid=9bd3b5f93692e4659632c8585eb35447

==== POST ====

keine

==== RETURN ====

Beispiel: 
<code javascript>
{"module":"users","error":0}
</code>