k4ever/devel/api

73 lines
1.6 KiB
Plaintext
Raw Normal View History

2011-09-28 10:51:32 +02:00
API
kaufen
produkte
auflisten
alle, nach gruppe
produktgruppen auflisten
suchen nach namen
hasDeposit falls kein attribut
beliebteste produkte (allgemein, nur vom user)
kaufen eines items (mit oder ohne deposit)
pfand zur<75>ckgeben
letzte eink<6E>ufe
transaction
auflisten zahlarten (bar, ueberweisung, ...)
einzahlen
auszahlen
letzte einzahlungen
api auth stuff
if plugin identifies by authblob
getUsersByAuthBlob (oderso)
else
authenticateUser(user, authblob)
listAuthBlobs (fuer alle user, die das plugin erlaubt haben)
canSuAsUser (noch ordentlich zu benennen)
cool w<>re:
irgendwann letzte <20>nderung der produktliste speichern
=== REST LIKE API STARTS HERE ===
buyable/
item/
GET (=list)
""" get a specific item or a full (group) item list """
group item belonging to group
id item with id
POST (=buy)
""" buy an item"
id [REQ] buy item with id
deposit
types/
GET (=list)
""" list all types (groups) which an item can belong to """
transaction/
transact/
GET (=list)
""" list your transactions """
num list $num entries
POST (=pay)
""" actually transact money """
amount [REQ] amount to add to your account
type [REQ] type of transaction (id)
types/
GET (=list)
""" list all available transaction types"
auth/
blob/
GET (=get)
""" return authblob if allowed or auth if str given """
blob blob to get user from / auth user with, returns User or NULL
POST
""" set authblob if allowed """
wget -q -O- --auth-no-challenge --http-user=seba -http-password=foobar23 http://devcat.someserver.de:13805/api2/buyable/item/foo