Appstore: Users

If your application is sold through the Spark store, you can retrieve and manage subscribers through this service.

Select Applications Only
Your application must be granted explicit permission to access this service. Contact api-support@sparkapi.com for more details.
  1. Supported Roles
  2. Available Services
    1. All Users
    2. Create User Subscription
  3. Appstore Users Description
  4. Expansions
  5. API Explorer

Supported Roles

Role Reads Writes Notes
IDX Yes No
Public Yes No
VOW Yes No
Portal Yes No
Private Yes No
More information about roles may be found here.

Available Services

All Users

URI: /<API Version>/appstore/users

HTTP Method Description Conditional Notes
GET Returns all users who have purchased your application No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
  • None

GET Response

{ 
  "D": {
    "Success": true,
    "Results": [
      {
        "Id": "20000809145531659995000000",
        "Name": "Joe Realtor"
      }
    ]
  }
}

Create User Subscription

URI: /<API Version>/appstore/users/<Account.Id>

HTTP Method Description Conditional Notes
GET Returns HTTP 405 (Method Not Allowed) No Not implemented
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Sets up a subscription to your app for the specified user. Useful when the user has purchased your application outside of the Spark store. No Only the Purchased attribute can be modified, and this may only be set to true.
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

PUT Request

Request body:
{
    "D": {
      "Purchased": true
    }
}

PUT Response

The standard success/fail response is returned.

Appstore Users Description

Attribute Data Type Description
Id Character The Spark account ID for the user
Name Character The user's full name.
Purchased Boolean Update only. Flags a user as having purchased the application.

Expansions

None.

API Explorer

The API Explorer does not currently support this service.