Difference between revisions of "API"
| Line 30: | Line 30: | ||
|'''currency''' | |'''currency''' | ||
|Returns Array(code, symbol) | |Returns Array(code, symbol) | ||
| + | |- | ||
| + | |'''create''' | ||
| + | |Requires '''steamid_for''' (32/64), '''amount''', '''packageid''' | ||
| + | Optional: '''steamid_buyer''' (32/64), '''name_buyer''', '''transactionid''', '''email''', '''gateway''' (default "api"), '''runonetimerewads''' (0/1, default 1), '''notify''' (0/1, default 1) | ||
|} | |} | ||
===news=== | ===news=== | ||
Returns Array(News1, News2, News3, ...) | Returns Array(News1, News2, News3, ...) | ||
| + | |||
| + | ===packages=== | ||
| + | {| class="wikitable" | ||
| + | !colspan="2"|Required Paramters | ||
| + | |- | ||
| + | |'''action''' | ||
| + | |The action you want to run | ||
| + | |- | ||
| + | !colspan="2"|Available Actions | ||
| + | |- | ||
| + | |'''assign''' | ||
| + | |Requires '''steamid''' (32/64), '''packageid''' | ||
| + | Optional: '''donationid''', '''days''', '''runonetimerewads''' (0/1, default 1), '''notify''' (0/1, default 1) | ||
| + | |} | ||
| + | |||
===timezone=== | ===timezone=== | ||
Revision as of 15:27, 2 January 2018
This is the API documentation. Please note that the API is new and that there aren't many functions at the moment. More functions will come with future updates.
Accessing the API
Naviagte to Admin -> Settings -> API. There, you can find the URL and the API key. Please be careful with the key, because it allows full access to the system.
The base URL has the following (GET) parameters:
| t | The target API page, see below |
| key | The API key |
API Pages
Here you can find the API pages. Arrays are returned in JSON.
donations
| Required Paramters | |
|---|---|
| action | The action you want to run |
| Available Actions | |
| goal | Returns Array(total, goal) |
| currency | Returns Array(code, symbol) |
| create | Requires steamid_for (32/64), amount, packageid
Optional: steamid_buyer (32/64), name_buyer, transactionid, email, gateway (default "api"), runonetimerewads (0/1, default 1), notify (0/1, default 1) |
news
Returns Array(News1, News2, News3, ...)
packages
| Required Paramters | |
|---|---|
| action | The action you want to run |
| Available Actions | |
| assign | Requires steamid (32/64), packageid
Optional: donationid, days, runonetimerewads (0/1, default 1), notify (0/1, default 1) |
timezone
No API Key required.
Returns the timezone offset.
user
| Required Paramters | |
|---|---|
| action | The action you want to run |
| steamid | The steamid64 or steamid32 of the user |
| Available Actions | |
| setgroup | Requires groupname and bundle (id).
Sets the group of the user in the specified bundle. |
| getgroup | Requires bundle (id).
Returns the group of the user in the specified bundle. |
