Professional Documents
Culture Documents
API
Documentation
Register
User
Account:
POST
Request:
POST
/api/users.php?format=json
HTTP/1.1
HOST:
localhost
content-‐length:
76
username=doctest&password=doctest&cnfpassword=doctest&email=doctest@test.com
Response:
{
"code": 1,
"status": 200,
"data":
{
"user": "doctest",
"message": "reg_success"
}
}
Screenshots:
User
Login:
GET
Request:
GET
/api/users.php?format=json&username=doctest&password=doctest
HTTP/1.1
HOST:
localhost
Response:
{
"code": 1,
"status": 200,
"data":
{
"username": "doctest",
"emailid": "doctest@test.com",
"token": "2c76e72a8ae99c3c485190157649b2a6"
}
}
Screenshots:
View
Profile:
GET
Request:
GET
/api/users.php?format=json&token=2c76e72a8ae99c3c485190157649b2a6
HTTP/1.1
HOST:
localhost
Response:
{
"code": 1,
"status": 200,
"data":
{
"username": "doctest",
"emailid": "doctest@test.com",
"token": "2c76e72a8ae99c3c485190157649b2a6",
"password": "doctest"
}
}
Screenshots:
Update
password:
PUT
Request:
PUT
/api/users.php?format=json
HTTP/1.1
HOST:
localhost
content-‐length:
267
<?xml
version="1.0"
standalone="yes"?>
<updatepassword>
<user>
<username>doctest</username>
<newpassword>doctest</newpassword>
<cnfnewpassword>doctest</cnfnewpassword>
<token>2c76e72a8ae99c3c485190157649b2a6</token>
</user>
</updatepassword>
Response:
{
"code": 1,
"status": 200,
"data":
{
"user":
{
0: "doctest"
}
,
"message": "update success"
}
}
Screenshots:
Delete
Account:
DELETE
Request:
DELETE
/api/users.php?format=json
HTTP/1.1
HOST:
localhost
content-‐length:
145
<?xml
version="1.0"
standalone="yes"?>
<deleteaccount>
<user>
<token>2c76e72a8ae99c3c485190157649b2a6</token>
</user>
</deleteaccount>
Response:
{
"code": 1,
"status": 200,
"data":
{
"user": "doctest",
"message": "delete success"
}
}
Screenshots:
Note:
Most
of
the
above
requests(may
not
be
all)
can
have
XML
and
JSON
responses
also.
Developers
just
need
to
specify
the
format={type}
as
a
GET
parameter.
The
following
example
shows
xml
response
for
update
password:
Request:
PUT
/api/users.php?format=xml
HTTP/1.1
HOST:
localhost
content-‐length:
267
<?xml
version="1.0"
standalone="yes"?>
<updatepassword>
<user>
<username>doctest</username>
<newpassword>doctest</newpassword>
<cnfnewpassword>doctest</cnfnewpassword>
<token>2c76e72a8ae99c3c485190157649b2a6</token>
</user>
</updatepassword>
Response:
<?xml
version="1.0"
encoding="UTF-‐8"?>
<response>
<code>1</code>
<status>200</status>
<data>
<user>doctest</user>
<message>update
success</message>
<data>
</response>
The
following
example
shows
plain
html
response
for
update
password:
Request:
PUT
/api/users.php?format=html
HTTP/1.1
HOST:
localhost
content-‐length:
267
<?xml
version="1.0"
standalone="yes"?>
<updatepassword>
<user>
<username>doctest</username>
<newpassword>doctest</newpassword>
<cnfnewpassword>doctest</cnfnewpassword>
<token>2c76e72a8ae99c3c485190157649b2a6</token>
</user>
</updatepassword>
Response:
code:1 status:200 user:doctest message:update success