The calls can be executed either by using auth_token or with an api_key. Every call requires one of them.

 

app.catalog.get_all

  • auth_token
  • user_id

Returns an array of applications. Every application looks like that:

{

   "authors": [   "System"    ],

    "icon": "http://server.com/MyApplication/Images/icon.png",

    "release_date": "2012-07-23",

    "version": "1.0",

    "access_token": "XnZ0LAUzfP0g3PC4oSs15RpLsxuVF1", // This will be an empty string "" unless the app is owned by the current user.

    "name": "Page Rating",

    "description": "This is the short summary of what the application does. Users will see this description in the application catalog.",

    "tags": [        "page rating",        "statistics"    ],

    "editions": [        {            "edition_id": 0,            "price": 0.00,            "currency": "USD",            "name": "Lite",            "description": "Some info about this edition."        }    ]",

    "availability": "public",

    "site": "",

    "debug": null,

    "owner_id": 4333,

   "id": "1",

   "app_edition_id": "1"

}

 

 app.catalog.install

Installs an application in the catalog

  • auth_token
  • user_id
  • url - URL to ad.json
  • sandbox - 0 or 1 - if the application is installed in the sandbox or directly published in the catalog

Returns the installed application data (like the single element in the returned data app.catalog.get_all).

 

app.catalog.update

Updates an application from the catalog

  • auth_token
  • user_id
  • app_id
  • url - URL to ad.json
  • sandbox - 0 or 1 - if the application is installed in the sandbox or directly published in the catalog

Returns the installed application data (like the single element in the returned data app.catalog.get_all).

 

app.catalog.publish

Publishes a sandbox application in the catalog.

  • auth_token
  • user_id
  • app_id

Returns the application data.

 

app.catalog.deinstall

Deinstalls an application from the catalog.

  • auth_token
  • user_id
  • app_id
  • sandbox - 0 or 1

Returns an error code only.

 

app.user.get_all

  • auth_token
  • user_id

Retrieves all installed user applications as 2 arrays:

{ "sandbox_applications": [ ...applications data... ], "installed_applications": [ ...applications data... ] }

 

app.user.install

Installs an application in a user account.

  • auth_token
  • user_id
  • app_id
  • edition_id

Returns the application data.

 

app.user.update

Updates an installed application with the latest version.

  • auth_token
  • user_id
  • app_id
  • edition_id

Returns the application data.

 

app.user.install_by_token

Installs an application by its token

  • auth_token
  • user_id
  • token - application token
  • edition_id - edition of the app (default: 0)

Returns the application data as well as edition_id and app_edition_id
 

app.user.deinstall

Deinstalls an application from the account.

  • auth_token
  • user_id
  • app_id

Returns an error code only.

 

app.user.set_settings

Stores application-related settings which is of JSON format.

  • auth_token
  • user_id
  • app_id
  • settings

Returns the stored settings


app.user.get_settings

Retrieves the application-related settings stored with set_settings

  • auth_token
  • user_id
  • app_id

Returns the stored settings

app.pricing.get_all

Retrieves the application-related details stored for application pricing
 

  • api_key
Returns the application data array of hashes:
[
   {
      "Name":"Lite",
      "Status":"1",
      "AppID":"20",
      "Price":"0",
      "EditionID":"0",
      "Currency":"USD",
      "Description":"10 appt, no staff, no vacations, no SMS, no per-day schedule"
   }
]



app.pricing.set

Store data for application pricing.
  • app_id
  • edition_id (optional) - default value '0'
  • name (optional) - default value 'Standard'
  • description (optional) - default value - empty string
  • price (optional) - default value - '0.00'
Returns the application data:
{
   "app_pricing":{
      "AppID":"33",
      "Name":"Premium",
      "Status":"1",
      "Price":"3",
      "EditionID":"3",
      "Currency":"USD",
      "Description":"Allinclusive"
   }
}