API Private

Private API, which uses secure token for communication, token can be retrived via API Public

/m/oauth2/com/delete_page

Delete page with all blocks

Scopes: api

HTTP Method: POST

Request params:

• uri - page URI

Request header:

Authorization: Bearer 9802c4a34e1535d8c3b721604ee0e7fb04116c49

Response (success):

{  
    "code": 200,
}

Response (error):

{  
   "error":"short error description here",
   "error_description":"long error description here"
}

/m/oauth2/com/change_account_password

Change account password

Scopes: api

HTTP Method: POST

Request params:

• password - new password

Request header:

Authorization: Bearer 9802c4a34e1535d8c3b721604ee0e7fb04116c49

Response (success):

{  
    "code": 200,
}

Response (error):

{  
   "error":"short error description here",
   "error_description":"long error description here"
}

/m/oauth2/com/switch_profile

Switch account active profile

Scopes: api

HTTP Method: POST

Request params:

• profile_id - profile id

Request header:

Authorization: Bearer 9802c4a34e1535d8c3b721604ee0e7fb04116c49

Response (success):

{  
    "code": 200,
}

Response (error):

{  
   "error":"short error description here",
   "error_description":"long error description here"
}

/m/oauth2/api/me

Provides information about current profile.

Scopes: basic, service, market

HTTP Method: GET

Request header:

Authorization: Bearer 9802c4a34e1535d8c3b721604ee0e7fb04116c49

Response (success):

{  
    "id":"123",
    "type":"bx_organizations",
    "email":"test@example.com",
    "role":"1",
    "name":"Test",
    "profile_display_name":"Test",
    "profile_link":"http:\/\/example.com\/path-to-una\/page\/view-organization-profile?id=12",
    "picture":"http:\/\/example.com\/path-to-una\/image_transcoder.php?o=bx_organizations_picture&h=36&dpx=1&t=1496247306"
}

Response (error):

{  
   "error":"short error description here",
   "error_description":"long error description here"
}

/m/oauth2/api/user

Provides information about particular profile profile.

Parameters:

• id - profile ID

Everything else is equivalent to /m/oauth2/api/me

/m/oauth2/api/friends

Get list of friends.

Scopes: basic, service, market

HTTP Method: GET

Parameters:

• id - profile ID

Request header:

Authorization: Bearer 9802c4a34e1535d8c3b721604ee0e7fb04116c49

Response (success):

{  
    "user_id":30,
    "friends":[  
        "24",
        "29",
        "51"
    ]
}

Response (error):

{  
   "error":"short error description here",
   "error_description":"long error description here"
}

/m/oauth2/api/market

Market service call.

Scopes: market, service

Everything is equivalent to /m/oauth2/api/service, only module name parameter can be ommited

/m/oauth2/api/service

Perform system call. For a list of avalibale service calls and their parameters refer to Service Calls page.

URL should look like this in case of service API call:

http://example.com/m/oauth2/api/service?module=bx_market&method=test&params[]=1&params[]=abc&class=custom_class_name_or_remove_it_if_main_module_class
http://example.com/m/oauth2/api/service?module=bx_market&method=test&params=serialized_string_of_params
http://example.com/m/oauth2/api/service?module=bx_market&method=test&params=json_string_of_params

Scopes: service

HTTP Method: GET, POST

Parameters:

• module - module name to perform service call in
• method - service call method
• params - parameters array
• class - custom module name if different from main module class

Request header:

Authorization: Bearer 9802c4a34e1535d8c3b721604ee0e7fb04116c49

Response (success): Depends on particular service call

Response (error): Error responce is described in particular service method. In case of general error (for example when service call isn't found, or error with token), the format is following:

{  
   "error":"short error description here",
   "error_description":"long error description here"
}