Wapka Site API

The Wapka Site API is an HTTP-based interface created for developers to manage there website.

Authorization Process

Each person is given a unique authentication token when they visite a site.. The token looks something like 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11, but we'll use simply <apikey> in this document instead. To obtain tokens You have to use #%VAR(APIKEY)%#.

Making requests

All queries to the Telegram Bot API must be served over HTTPS and need to be presented in this form: https://api.wapka.org/<apikey>/METHOD_NAME. Like this for example:

https://api.wapka.org/123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/getMe

https://api.wapka.org/#%VAR(APIKEY)%#/getMe

We support GET and POST HTTP methods. We support four ways of passing parameters in Wapka Site API requests:

• URL query string
• application/x-www-form-urlencoded
• application/json (except for uploading files)
• multipart/form-data (use to upload files)

The response contains a JSON object, which always has a Boolean field 'ok' and may have an optional String field 'description' with a human-readable description of the result. If 'ok' equals True, the request was successful and the result of the query can be found in the 'result' field. In case of an unsuccessful request, 'ok' equals false and the error is explained in the 'description'. An Integer 'error_code' field is also returned.

• All methods in the Wapka Site API are case-insensitive.
• All queries must be made using UTF-8.

Available methods

All methods in the Wapka Site API are case-insensitive. We support GET and POST HTTP methods. Use either URL query string or application/json or application/x-www-form-urlencoded or multipart/form-data for passing parameters in Bot API requests.
On successful call, a JSON-object containing the result will be returned.

getMe

A simple method for geting information about current user. Requires no parameters. Returns current user Info in form of a UserInfo object.

UserLogin

Use this method for user login process. On success, the sent UserInfo is returned.

Parameter	Type	Required	Description
username	String	Yes	Unique User Name string
email	String	Optional	User Email address
password	String	Yes	User password for verification

---

UserLogout

Use this method to log out Current User and destroy API KEY. Returns True on success. Requires no parameters.

UserRegister

Use this method for user registration process. On success, the sent UserInfo is returned.

Parameter	Type	Required	Description
username	String	Yes	Unique User Name string
email	String	Optional	User Email address
password	String	Yes	User password for verification

---

UserInfo

Use this method to get user information. On success, the sent UserInfo is returned.

Parameter	Type	Required	Description
id, id_not	Mix	optional	Get user by there id. id_not will filter user
username, username_not	Mix	optional	Filter user by there unique name
email, email_not	Mix	Optional	Filter user by Email address
type, type_not	Mix	Optional	Filter user by
role, role_not	Mix	Optional	Get User by there role
search	String	Optional	Search for user
page	String	Intger	User password for verification
limit	Intger	Yes	User password for verification
page	Intger	Optional	Get N page

---

UserEdit

Use this method to update user information. On success, the sent UserInfo is returned.

Parameter	Type	Required	Description
username	String	Yes	Unique User Name string
email	String	Optional	User Email address
password	String	Yes	User password for verification

---

And that's about all we've got for now.
If you've got any questions, please check out our FAQ »