Difference between revisions of "API"
Jump to navigation
Jump to search
| Line 14: | Line 14: | ||
==API Pages== | ==API Pages== | ||
| + | Here you can find the API pages. Arrays are returned in JSON. | ||
| + | ===donations=== | ||
| + | {| class="wikitable" | ||
| + | !colspan="2"|Required Paramters | ||
| + | |- | ||
| + | |'''action''' | ||
| + | |The action you want to run | ||
| + | |- | ||
| + | !colspan="2"|Available Actions | ||
| + | |- | ||
| + | |'''goal''' | ||
| + | |Returns Array(total, goal) | ||
| + | |- | ||
| + | |'''currency''' | ||
| + | |Returns Array(code, symbol) | ||
| + | |} | ||
| + | |||
===user=== | ===user=== | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 32: | Line 49: | ||
|'''getgroup''' | |'''getgroup''' | ||
|Requires '''bundle''' (id). | |Requires '''bundle''' (id). | ||
| − | Returns the group of the | + | Returns the group of the user in the specified bundle. |
|} | |} | ||
Revision as of 12:23, 22 October 2016
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 allow full access to the system. The base URL as 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) |
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. |
