QuickBlox Developers (API docs, code samples, SDK) - Recent changes [en]

Users

2012-05-18T09:09:38Z

Parameters:

Authentication and Authorization

2012-05-18T09:01:38Z

Request:

Show changes

Messages

2012-05-15T09:12:14Z

Create subscriptions (subscribes):

Content

2012-05-15T08:43:01Z

Response:

Content

2012-05-15T08:23:53Z

Declaring file uploaded:

Users

2012-05-15T07:34:15Z

Parameters:

Ratings

2012-05-15T07:16:43Z

Ratings API:

Messages

2012-05-15T07:15:30Z

Typical use сases:

Content

2012-05-15T07:14:02Z

Content API:

Errors

2012-05-14T16:41:47Z

Any request with invalid owner_id:

Authentication and Authorization

2012-05-14T16:39:44Z

Parameters:

Users

2012-05-14T16:31:19Z

Parameters:

Authentication and Authorization

2012-05-14T16:26:01Z

Request:

@@ Line 231: / Line 231: @@
 |user[password] ||Yes ||String ||mypassword ||API User password
 |-
-|user[owner_id] '''(deprecated after 2012-05-30)''' ||Yes ||Integer ||3 ||ID of API User owner
+|user[owner_id] ||Yes ||Integer ||3 ||ID of API User owner
 |-
 |user[blob_id] ||Optional ||Integer ||412 ||ID of associated blob (for example, API User photo)

@@ Line 220: / Line 220: @@
 ==== Create subscriptions (subscribes) ====
-Сreate device based subscriptions. The authorization token should contain the device parameters (platform, udid)
+Сreate device based subscriptions. The authorization token should contain the device parameters. If the subscription is creating for the windows phone pushes make sure that Microsoft Push Notifications have a status "enabled" in the Web Administration Panel.
 ===== Parameters =====

@@ Line 560: / Line 560: @@
 ====Delete file====
-Delete file by ID. If there are some referents to the file the number of links will be reduced by 1 efter deleting. A file will be deleted in fact when the number of links will be equal to null.
+Delete file by ID. If there are some referents to the file the number of links will be reduced by 1 after deleting. A file will be deleted in fact when the number of links will be equal to 0.
 ===== Request =====
@@ Line 575: / Line 575: @@
 <div class="tabs">
 <div title="Curl Response (xml)">Empty body, status: 200</div>
-<div title="Curl Response (json)">Status: 200, null</div>
+<div title="Curl Response (json)">Empty body, status: 200</div>
 </div>
 <br>
 <span id="API_Content_Increasing_A_Number_Of_The_Links_To_The_File"></span>

@@ Line 131: / Line 131: @@
 ====Create a file====
-Create a file
+Create an entity which is a file in a system
 ===== Parameters =====
@@ Line 140: / Line 140: @@
 |blob[content_type]  ||Yes || MIMEType (max 30 chars)||image/jpeg || mime content type
 |-
-|blob[name]  ||Yes ||String (min 3 chars. max 30 chars)||455 || File name
+|blob[name]  ||Yes ||String (min 3 chars. max 30 chars)||museum || File name
 |-
 |blob[multipart]  ||Yes || String || 0|| Must be a string "0"
@@ Line 322: / Line 322: @@
 ====Declaring file uploaded====
-Declaring file uploaded. Set file status to 'Complete'. If the specified file size does not match to the actual, the actual is set
+Declaring file uploaded. Set file status to 'Complete'. If the specified file size does not match to the actual, the actual will be set
 ===== Parameters =====
@@ Line 472: / Line 472: @@
 ====Edit file====
-Edit file by ID
+Edit a file by ID
 ===== Request =====
@@ Line 530: / Line 539: @@
 <span id="API_Content_Delete_File"></span>
-====Delete file====
+====Increasing a number of the links to the file====
-Delete file by ID
+Increasing a number of the links to the file
 ===== Request =====
 <div class="tabs">
 <syntaxhighlight lang="bash" title="Curl Request (xml)">
-curl -X DELETE "http://api.quickblox.com/blobs/38.xml?token=69217f8cfa59ebbb42d610ccb8ac1e55988cadd7"
+curl -X PUT "http://api.quickblox.com/blobs/39/retain.xml?token=69217f8cfa59ebbb42d610ccb8ac1e55988cadd7"
 </syntaxhighlight>
 <syntaxhighlight lang="bash" title="Curl Request (json)">
-curl -X DELETE "http://api.quickblox.com/blobs/97.json?token=69217f8cfa59ebbb42d610ccb8ac1e55988cadd7"
+curl -X PUT "{token: 74b0087b00d748f944429f1c355b91169f5d9d52}" http://api.quickblox.com/blobs/102/retain.json?
 </syntaxhighlight>
 </div>
@@ Line 550: / Line 559: @@
 <br>
-<span id="API_Content_Increasing_A_Number_Of_The_Links_To_The_File"></span>
+====Delete file====
+Delete file by ID. If there are some referents to the file the number of links will be reduced by 1 efter deleting. A file will be deleted in fact when the number of links will be equal to null.
-====Increasing a number of the links to the file====
-Increasing a number of the links to the file
 ===== Request =====
 <div class="tabs">
 <syntaxhighlight lang="bash" title="Curl Request (xml)">
-curl -X PUT "http://api.quickblox.com/blobs/39/retain.xml?token=69217f8cfa59ebbb42d610ccb8ac1e55988cadd7"
+curl -X DELETE "http://api.quickblox.com/blobs/38.xml?token=69217f8cfa59ebbb42d610ccb8ac1e55988cadd7"
 </syntaxhighlight>
 <syntaxhighlight lang="bash" title="Curl Request (json)">
-curl -X PUT "{token: 74b0087b00d748f944429f1c355b91169f5d9d52}" http://api.quickblox.com/blobs/102/retain.json?
+curl -X DELETE "http://api.quickblox.com/blobs/97.json?token=69217f8cfa59ebbb42d610ccb8ac1e55988cadd7"
 </syntaxhighlight>
 </div>
@@ Line 571: / Line 578: @@
 </div>
 <br>

@@ Line 825: / Line 825: @@
 !align="center" |Param !!Required !!Type !!Value Example !!Description
 |-
 |user[blob_id] ||Optional ||Integer ||412 ||ID of associated blob (for example, API User photo)

@@ Line 15: / Line 15: @@
 == Ratings API ==
 === Requests and Responses ===
@@ Line 1,278: / Line 1,290: @@
 </div>
 <br>

@@ Line 26: / Line 26: @@
 == Messages API ==
 === Requests and Responses  ===
@@ Line 1,092: / Line 1,113: @@
 </div>
 <br>

@@ Line 27: / Line 27: @@
 == Content API ==
 === Requests and Responses  ===
@@ Line 561: / Line 571: @@
 </div>
 <br>

← Older revision		Revision as of 16:41, 14 May 2012
Line 52:		Line 52:

	===Unprocessable Entity===		===Unprocessable Entity===
−	~~====Any request with invalid owner_id====~~
−
−	~~<div class="tabs">~~
−	~~<syntaxhighlight lang="bash" title="Request">~~
−	~~curl -X POST -d "user[login]=login1&user[password]=coolpass&user[owner_id]=3&token=7c1215fd0c682c8b4aa2f75979d618485297e5c0" http://api.quickblox.com/users.xml~~
−	~~</syntaxhighlight>~~
−	~~<syntaxhighlight lang="xml" title="Response">~~
−	~~<?xml version='1.0' encoding='UTF-8'?> <errors>~~
−	~~<error>~~
−	~~Owner does not exist~~
−	~~</error>~~
−	~~</errors>~~
−	~~</syntaxhighlight>~~
−	~~</div>~~
−
	====User with login that has already been taken====		====User with login that has already been taken====

@@ Line 101: / Line 101: @@
 !align="center" |Param !!Required !!Type !!Value Example !!Description
 |-
-|user[login] ||Optional ||String ||bukster ||[http://wiki.quickblox.com/Overview#API_User API User] login
+|user[login] ||Yes ||String ||bukster ||[http://wiki.quickblox.com/Overview#API_User API User] login
 |-
-|user[password] ||Optional ||String ||bad-as-passwd ||[http://wiki.quickblox.com/Overview#API_User API User] password
+|user[password] ||Yes ||String ||bad-as-passwd ||[http://wiki.quickblox.com/Overview#API_User API User] password
 |-
-|user[owner_id] ||Optional ||Integer ||2 ||[http://wiki.quickblox.com/Overview#API_User API User] owner identifier
+|user[owner_id] '''(deprecated after 2012-05-30)''' ||Yes ||Integer ||2 ||[http://wiki.quickblox.com/Overview#API_User API User] owner identifier
 |}
@@ Line 277: / Line 277: @@
 |password ||Yes ||String ||mypassword ||API User password
 |-
-|owner_id ||Yes ||Integer ||3 ||ID of '''user owner'''
+|owner_id '''(deprecated after 2012-05-30)''' ||Yes ||Integer ||3 ||ID of '''user owner'''
 |}

@@ Line 44: / Line 44: @@
 ! align="center" |URL !![http://en.wikipedia.org/wiki/REST#RESTful_web_services HTTP Verb] !!Supported formats !!Action Description !!Success HTTP Status Code
 |+
-|/auth ||[http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#POST POST] ||
+|/auth '''(deprecated)'''<br> /session ||[http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#POST POST] ||
 * xml
 * json
 ||[[#API Session Creation|API Session Creation]] Or [[#CombinedAPIUserAuthentication|API User Sing In]] ||[http://en.wikipedia.org/wiki/Http_status_codes#201 201]
 |-
-|/users/authenticate ||[http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#POST POST] ||
+|/users/authenticate '''(deprecated)'''<br> /login ||[http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#POST POST] ||
 * xml
 * json
-||[[#API User Sign In|API User Sign In]] ||[http://en.wikipedia.org/wiki/Http_status_codes#202  202]
+|| [[#API User Sign In|API User Sign In]] ||[http://en.wikipedia.org/wiki/Http_status_codes#202  202]
 |-
-|/auth_exit ||[http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#DELETE DELETE] ||
+|| /login
 * xml
 * json
-||[[#API Session Destroy|API Session Destroy]] ||[http://en.wikipedia.org/wiki/Http_status_codes#200 200]
+|| [[#API User Sign Out|API User Sign Out]]
 |}
@@ Line 117: / Line 125: @@
 <div class="tabs">
 <syntaxhighlight lang="bash" title="Curl Request (xml)">
-curl -X POST -d "application_id=140&auth_key=7quWEh-k6TqghXe&timestamp=1326964049&nonce=414546828&signature=e6e603c251a569e70a2f27a8c71b5017e81e05d5" https://api.quickblox.com/auth.xml
+curl -X POST -d "application_id=140&auth_key=7quWEh-k6TqghXe&timestamp=1326964049&nonce=414546828&signature=e6e603c251a569e70a2f27a8c71b5017e81e05d5" https://api.quickblox.com/session.xml
 </syntaxhighlight>
 <syntaxhighlight lang="bash" title="Curl Request (json)">
-curl -X POST -H "Content-Type: application/json" -d '{"application_id": "2", "auth_key": "DtF9cZPqTF8Wy9Q", "timestamp": "1333630392", "nonce": "1236221330", "signature": "eb0ec2d8c8184a3e62b41da2afb6e8d690577fa4"}' https://api.quickblox.com/auth.json
+curl -X POST -H "Content-Type: application/json" -d '{"application_id": "2", "auth_key": "DtF9cZPqTF8Wy9Q", "timestamp": "1333630392", "nonce": "1236221330", "signature": "eb0ec2d8c8184a3e62b41da2afb6e8d690577fa4"}' https://api.quickblox.com/session.json
 </syntaxhighlight>
 </div>
@@ Line 165: / Line 173: @@
 <div class="tabs">
 <syntaxhighlight lang="bash" title="Curl Request (xml)">
-curl -X POST -d "application_id=140&auth_key=wJHdOcQSxXQGWx5&timestamp=1326964799&nonce=1392970566&signature=547fc3862220f19768c406f47f30897051794686&user[login]=iostest&user[password]=iostest&user[owner_id]=4360" https://api.quickblox.com/auth.xml
+curl -X POST -d "application_id=140&auth_key=wJHdOcQSxXQGWx5&timestamp=1326964799&nonce=1392970566&signature=547fc3862220f19768c406f47f30897051794686&user[login]=iostest&user[password]=iostest&user[owner_id]=4360" https://api.quickblox.com/session.xml
 </syntaxhighlight>
 <syntaxhighlight lang="bash" title="Curl Request (json)">
-curl -X POST -H "Content-Type: application/json" -d '{"application_id": "2", "auth_key": "DtF9cZPqTF8Wy9Q", "timestamp": "1333630580", "nonce": "1340569516", "signature": "13293a5bd2026b957ebbb36c89d9649aae9e5503", "user": {"login": "injoit", "password": "injoit", "owner_id": "4"}}' https://api.quickblox.com/auth.json
+curl -X POST -H "Content-Type: application/json" -d '{"application_id": "2", "auth_key": "DtF9cZPqTF8Wy9Q", "timestamp": "1333630580", "nonce": "1340569516", "signature": "13293a5bd2026b957ebbb36c89d9649aae9e5503", "user": {"login": "injoit", "password": "injoit", "owner_id": "4"}}' https://api.quickblox.com/session.json
 </syntaxhighlight>
 </div>
@@ Line 213: / Line 221: @@
 <div class="tabs">
 <syntaxhighlight lang="bash" title="Curl Request (xml)">
-curl -X POST -d "application_id=92&auth_key=wJHdOcQSxXQGWx5&device[platform]=ios&device[udid]=3429C429-4C34-5214-8E3C-803AC0CA79ED&nonce=420&signature=29b5a3f85c481336aee0ba134f45797c5a9d2133&timestamp=1332415909" https://api.quickblox.com/auth.xml
+curl -X POST -d "application_id=92&auth_key=wJHdOcQSxXQGWx5&device[platform]=ios&device[udid]=3429C429-4C34-5214-8E3C-803AC0CA79ED&nonce=420&signature=29b5a3f85c481336aee0ba134f45797c5a9d2133&timestamp=1332415909" https://api.quickblox.com/session.xml
 </syntaxhighlight>
 <syntaxhighlight lang="bash" title="Curl Request (json)">
-curl -X POST -H "Content-Type: application/json" -d '{"application_id": "2", "auth_key": "DtF9cZPqTF8Wy9Q", "timestamp": "1336488307", "nonce": "855029415", "signature": "e8d8b7e768f487a9f422063c6addef6e0bc58023", "user": {"login": "injoit", "password": "injoit", "owner_id": "4"}, "device": {"platform": "ios", "udid": "7847674035" }}' https://api.quickblox.com/auth.json
+curl -X POST -H "Content-Type: application/json" -d '{"application_id": "2", "auth_key": "DtF9cZPqTF8Wy9Q", "timestamp": "1336488307", "nonce": "855029415", "signature": "e8d8b7e768f487a9f422063c6addef6e0bc58023", "user": {"login": "injoit", "password": "injoit", "owner_id": "4"}, "device": {"platform": "ios", "udid": "7847674035" }}' https://api.quickblox.com/session.json
 </syntaxhighlight>
 </div>
@@ Line 276: / Line 284: @@
 <div class="tabs">
 <syntaxhighlight lang="bash" title="Curl Request (xml)">
-curl -X POST -d "login=Alisa&password=Alisa&owner_id=4&token=b284ddf44f5369611fe14e0e588f1cfa855116c8" http://api.quickblox.com/users/authenticate.xml
+curl -X POST -d "login=Alisa&password=Alisa&owner_id=4&token=b284ddf44f5369611fe14e0e588f1cfa855116c8" http://api.quickblox.com/login.xml
 </syntaxhighlight>
 <syntaxhighlight lang="bash" title="Curl Request (json)">
-curl -X POST -H "Content-Type: application/json" -d '{"login": "injoit", "password": "injoit", "owner_id": "4", "token": "cf5709d6013fdb7a6787fbeb8340afed8aec4c69"}' http://api.quickblox.com/users/authenticate.json
+curl -X POST -H "Content-Type: application/json" -d '{"login": "injoit", "password": "injoit", "owner_id": "4", "token": "cf5709d6013fdb7a6787fbeb8340afed8aec4c69"}' http://api.quickblox.com/login.json
 </syntaxhighlight>
 </div>
@@ Line 323: / Line 331: @@
    "updated_at": "2012-04-04T10:27:40Z",
    "website": null,
-   "tags": [
+   "user_tags":"superman"
-−
-      "tag": {
-        "id": 1,
-        "name": "hello"
-−
-−
-−
+}
 </syntaxhighlight>
@@ Line 351: / Line 352: @@
 <div class="tabs">
 <syntaxhighlight lang="bash" title="Curl Request (xml)">
-curl -X DELETE "https://api.quickblox.com/auth_exit.xml?token=422ce2791d7070b88a82f415b3693c81612e3423"
+curl -X DELETE "https://api.quickblox.com/session.xml?token=422ce2791d7070b88a82f415b3693c81612e3423"
 </syntaxhighlight>
 <syntaxhighlight lang="bash" title="Curl Request (json)">
-curl -X DELETE "http://api.quickblox.com/auth_exit.json?token=8b75a6c7191285499d890a81df4ee7fe49bc732a"
+curl -X DELETE "http://api.quickblox.com/login.json?token=8b75a6c7191285499d890a81df4ee7fe49bc732a"
 </syntaxhighlight>
 </div>