Getting Started

This page has the purpose of providing all the required infos and a possible action list to help you start playing with out API. This should give you an idea about the standard flow of calls, but things has not to necessary be done in this order.

IMPORTANT

  • Authentication: AppsBuilder API supports both Cookies Based and HTTP Headers Based Authentication methods. Unfortunately Mashape Unirest library does not support Cookies originally; if you are planning to use it (or to avoid the use of Cookies) you have to integrate ad additional header named 'X-AppsBuilder-Authorization' in your calls. The endpoint /auth/connect (or /cms/connect) will return the token that has to be passed as the value of that HTTP Header.

    • Using Unirest lib, an example call on /user/getApps would result in:
      Unirest::get( "https://appsbuilder.p.mashape.com/user/getApps" , array(
      "X-Mashape-Authorization" => "MASHAPE_KEY",
      "X-AppsBuilder-Authorization" => "519b21d641ec72.67282446"
      ));
  • Models and Structures: If you have any doubts about API data models and structures, please take note that a description of them can be found here: https://appsbuilder.atlassian.net/wiki/display/res/App+JSON

Example list of calls

  1. Register as a new user on the CMS: /cms/register

  2. Login with your new credentials: /cms/login

  3. Create a new app: /app/createApp2

  4. Update app infos, setting a title and any other desired values: /app/updateApp/{id}

  5. Set the app layout: /layout/setLayout/{id}

  6. Set a new app content tree: /category/addAppTree/{id}

    • (Currently this is not an easy step, as you have to generate the whole app tree structure every time, even if you just wanted to add or remove a single page. We are working on an optimized API set to facilitate those tasks. For your tests feel free to use the following string.)
      [{"nome":"News","img":"http:\/\/az347768.vo.msecnd.net\/site\/t1362074783$img$icons$news.png","descrizione":"","layout":"list","layoutoption":{},"pageoption":{},"option":{"type":"xml","urltype":"news","url":"http:\/\/blog.apps-builder.com\/feed\/","img":true,"cache":false,"backbtn_for_webview":false,"pid":143697},"cell":{},"child":[]},{"nome":"Web Site","img":"http:\/\/az347768.vo.msecnd.net\/site\/t1362074783$img$icons$website.png","descrizione":"","layout":"list","layoutoption":{},"pageoption":{},"option":{"type":"site","url":"http:\/\/blog.apps-builder.com","open":"inside","cache":false,"backbtn_for_webview":false,"pid":143700},"cell":{},"child":[]},{"nome":"Email Us","img":"http:\/\/az347768.vo.msecnd.net\/site\/t1362074783$img$icons$email.png","descrizione":"","layout":"list","layoutoption":{},"pageoption":{},"option":{"type":"site","open":"outside","itype":"mail","email":"info@apps-builder.com","subject":"Subject text","msg":"Message text","url":"mailto:info@apps-builder.com?subject=Subject%20text&body=Message%20text"},"cell":{},"child":[]}]
  7. Set any app style options: /style/addStyle/{id}
  8. Build the app package for a specific device: /builder/createApp/{id}/{device}
  9. Download the built package: /builder/getApp/{id}/{device}
Last 7 days, UTC

Average Latency
101ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Header Authentication
 

Authentication via HTTP header is needed on every call except for login one. More infos can be found on Readme - Getting starter section.


Authentication
Description
Parameter
String

This is the auth token returned by the login call. (e.g. 519b21d641ec72.67282446)

X-AppsBuilder-Authorization

Required

Administration

HTTP 200 : string POST/cms/set_app_expire
Set App Expire Time

Allows a CMS admin to set an Expire Time for an app.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

app_id

Required

string

This is the number of days after which the app will expire.
Example: 30

expire

Required

HTTP 200 : string GET/cms/set_app_expired/{id}
Set App Expired

Allows a CMS admin to set an app as Expired, which means that the user will still see his app on the dashboard, but will not be able to edit it until when that app is set as Paid.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string GET/cms/set_app_payed/{id}
Set App Paid

Allows a CMS admin to set an app as Paid. This action should take place after that a payment has occurred. By now the owner of the app will be able to edit his app.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

Advertisement

HTTP 200 : AdvStatus GET/ad/getAdvStatus/{id}
						{
  "id": "1",
  "active": "1",
  "admob": "ABC123",
  "adsense": "",
  "inmobi": "",
  "inmobi_verification": "",
  "mobfox": "123ABC",
  "neomobile": "",
  "custom": "http://your_url"
}						
Get Adv Status

Allow an existing user to get the app advertissement network settings.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string GET/ad/setAdvStatus/{id}/{enable}
Set Adv Status

Allows an existing user to enable/disable advertisement for one of his apps.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is a boolean value that indicates if the advertisement should be disabled or enabled. Possible values: "0|1".
Example: 0

enable

Required

HTTP 200 : string POST/ad/setAdvID/{id}
Set Adv Values

Allows an existing user to set the values for his app advertisement services.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the Inmobi publisher ID.
Example: abc123

inmobi

Required

string

This is the Inmobi verification code.
Example: abc123

inmobi_verification

Required

string

This is the Mobfox publisher ID.
Example: abc123

mobfox

Required

string

This is the Adsense publisher ID.
Example: abc123

adsense

Required

string

This is the Neomobile publisher ID.
Example: abc123

neomobile

Required

string

This is a custom URL where to retrieve the advertisement.
Example: http://my_url

custom

Required

App Building

HTTP 200 : string POST/builder/addKey/{id}/{device}
Add Certificate

Allows an existing user to upload iOS and Android certificates and keys required to compile a specific app package.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the type of device to upload the certificate for. Allowed values: "apple|android".
Example: apple

device

Required

string

Required when device = "apple". This is the password used to generate the .p12 certificate file.
Example: my_p12_password

password

Optional

binary

Required when device = "apple". This is the .p12 certificate file.
Example: my_p12_file

p12

Optional

binary

Required when device = "apple". This is the mobile provision file.
Example: my_mobileprovision_file

mobileprovision

Optional

binary

Required when device = "android". This is the keystore file.

keystore

Optional

string

Required when device = "android". This is the password used to generate the keystore file.

keystorepwd

Optional

string

Required when device = "android". This is the key alias.

alias

Optional

string

Required when device = "android". This is the alias password.

pwd

Optional

HTTP 200 : string GET/builder/createApp/{id}/{device}
Build App

Allows an existing user to compile and create the package of one of his apps, for a specific device type. Returns a JSON with the position of the app in the building queue on success, or an error message (for e.g. in case the app has already been inserted in the queue). The “Is Building” function should be used to test building procedure completion.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the type of device to download the app for. Allowed values: "apple|android|chrome".
Example: apple

device

Required

HTTP 200 : string GET/builder/deleteKey/{id}/{device}
Delete Certificate

Allows an existing user to remove his uploaded iOS and Android certificates and keys for a specific app.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the type of device to delete the certificate for. Allowed values: "apple|android".
Example: apple

device

Required

HTTP 200 : binary GET/builder/getApp/{id}/{device}
Get App

Allows an existing user to download the compiled package of one of his apps, for a specific device type. Returns the app binary file.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the type of device to download the app for. Allowed values: "apple|android|chrome".
Example: apple

device

Required

HTTP 200 : binary GET/builder/getKey/{id}/{device}/{element}
Get Certificate

Allows an existing user to retrieve his uploaded iOS and Android certificates and keys for a specific app. Returns the binary file or a string with the password.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the type of device to download the certificate for. Allowed values: "apple|android".
Example: apple

device

Required

string

Required when device = "apple". This is the certificate element the user asks for. If the element passed is "p12" or "mobileprovision" a binary file will be returned; if it is "pwd" the password used to generate the .p12 file will be returned. Possible values: "p12|mobileprovision|pwd".
Example: p12

element

Required

HTTP 200 : string GET/builder/getLastBuildInfos/{id}⁄{device}
Get Last Building Infos

Allows an user to retrieve the informations about the last app building process (success, errors, and so on). Returns a JSON with multiple keys.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the type of device to download the app for. Allowed values: "apple|android|chrome".
Example: apple

device

Required

HTTP 200 : string GET/builder/getNextBuildVersion/{id}
Get Next Build ID

Allows a user to get the next "build ID" used for his app by the Build App endpoint, necessary in "Is Build App Complete" call. Returns a number.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string GET/builder/isBuilding/{id}/{device}
Is Building App

Allows a user to verify if the building process for his app, launched through Build App, is completed. Returns a JSON object with "is_building" boolean key.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the type of device to download the app for. Allowed values: "apple|android|chrome".
Example: apple

device

Required

HTTP 200 : string POST/builder/setOption/{id}
Set Build Option

Allows an existing user to set a building option on one of his apps.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the name of the option to be set. Possible values: "disableipad|audio|gps".
Example: disableipad

name

Required

number

This is a boolean value for the option set by the name parameter. Possible values: 0|1.
Example: 0

value

Required

App Content

HTTP 200 : Page GET/category/getAppTree/{id}
						[{
  "cell": {
    "bgalpha": 0.8,
    "bgcolor": "#FFFFFF",
    "cell_valign": "middle",
    "img_halign": "center",
    "img_style": "default",
    "img_valign": "middle",
    "imgsize": [
      60, 60
    ],
    "overlay": false,
    "text_align": "center",
    "text_bgalpha": 1.0,
    "text_bgcolor": "#000000",
    "text_position": "bottom",
    "text_valign": "middle"
  },
  "child": [
    <Page>
  ],
  "descrizione": "A quite long description",
  "img": "http://image_url",
  "layout": "grid2",
  "layoutoption": {
    "autoopen": 3,
    "banners": {
      "landscape": [
        {
          "type": "image",
          "url": "http://image_url",
          "width": "320",
          "height": "80"
        }
      ],
      "portrait": [
        {
          "type": "image",
          "url": "http://image_url",
          "width": "480",
          "height": "60"
        }
      ]
    },
    "cell_margin": [
      "5",
      "5",
      "5",
      "5"
    ],
    "colorscheme": {
      "col_even_bgalpha": 0.5,
      "col_even_bgcolor": "#FFFFFF",
      "col_odd_bgalpha": 0.5,
      "col_odd_bgcolor": "#FFFFFF",
      "row_even_bgalpha": 0.5,
      "row_even_bgcolor": "#FFFFFF",
      "row_odd_bgalpha": 0.5,
      "row_odd_bgcolor": "#FFFFFF"
    },
    "halign": "center",
    "hideDescription": 1,
    "hideTitle": 1,
    "ipadautoopen": 3,
    "nrows": 4,
    "rotate": true,
    "row_height": 100,
    "scroll": "horizontal",
    "valign": "middle",
    "width": 80,
    "win8": {
      "home_layout": "grouped",
      "page_layout": "tabs",
      "bgcolor": "#FFFFFF",
      "bgalpha": 0.5,
      "bgimg": "http://image_url",
      "icon_bgcolor": "#333333"
    }
  },
  "nome": "A good page title",
  "option": {
    "type": "xml",
    "urltype": "image",
    "url": "http://my_url_2",
    "txt": "dGV4dA==",
    "img": "true",
    "open": "inside",
    "add": "http://my_url",
    "backbtn_for_webview": true,
    "cache": true,
    "subtype": "contacts",
    "values": [
      {
        "name": "My company email",
        "type": "mail",
        "value": "my_company@my_domain.com"
      }
    ]
  },
  "pageoption": {
    "auth": {
      "checkurl": "http://my_domain/check_url",
      "loginurl": "http://my_domain/login_url",
      "logouturl": "http://my_domain/logout_url",
      "message": "A pleasant welcome message.",
      "registerurl": "http://my_domain/register_url",
      "type": "userpwd"
    },
    "disabled": true
  }
}]						
Get App Content

Allows an existing user to retrieve one of his apps content. Returns the content JSON structure or "false".


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string POST/category/addAppTree/{id}
Set App Content

Allows an existing user to set the content of one of his apps. Returns "true" on success, or "false" on failure.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is an array of Page objects, that represents the app content structure.
Example: Page

tree

Required

App Management

HTTP 200 : string POST/cms/addappassign/{id}
Assign App to User

Allows a CMS admin/superuser to assign an app to a user.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the user ID.
Example: 3

username

Required

HTTP 200 : string GET/app/cloneApp/{id}
Clone App

Allows an existing user to clone one of his apps. Returns the newly created app ID or "false".


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string GET/app/createApp2
Create App

Allows an existing user to create a new app. Returns the newly created app ID or "false".


HTTP 200 : string GET/app/deleteApp/{id}
Delete App

Allows an existing user to delete one of his apps. Returns "false" in case of error.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : AppInfos GET/app/getAppInfos/{id}
						{
  "id": "1",
  "user": "1",
  "titolo": "MyLovelyApp",
  "language": "en",
  "descrizione": "My lovely app description",
  "keywords": "my_company,my_name",
  "url_support": "http://my_support_url",
  "email_support": "my_support_email@my_domain.com",
  "app_icon": "http://my_icon_url",
  "category": "Business",
  "splash_image": "http://my_splash_url",
  "data": "2011-05-01 11:00:00",
  "infos": "This app is powered by myself",
  "bundle_android": "myname.myapp",
  "bundle_apple": "myname.myapp",
  "google_verification": "123ABC",
  "phone": "000111222",
  "privacy_url": "http://my_privacy_url",
  "dns": "",
  "public": "1",
  "updated": "2011-05-03 18:00:00"
}						
Get App Infos

Allows an existing user to retrieve infos of one of his apps. Returns a JSON with its infos or "false".


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string GET/app/quality/{id}
Get App Quality

Allows an existing user to retrieve the quality of an app based on an AppsBuilder rating. Returns a number, which must be considered a percentage.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : AppInfos GET/user/getApps
						[{
  "id": "1",
  "user": "1",
  "titolo": "MyLovelyApp",
  "language": "en",
  "descrizione": "My lovely app description",
  "keywords": "my_company,my_name",
  "url_support": "http://my_support_url",
  "email_support": "my_support_email@my_domain.com",
  "app_icon": "http://my_icon_url",
  "category": "Business",
  "splash_image": "http://my_splash_url",
  "data": "2011-05-01 11:00:00",
  "infos": "This app is powered by myself",
  "bundle_android": "myname.myapp",
  "bundle_apple": "myname.myapp",
  "google_verification": "123ABC",
  "phone": "000111222",
  "privacy_url": "http://my_privacy_url",
  "dns": "",
  "public": "1",
  "updated": "2011-05-03 18:00:00"
}]						
Get User Apps Infos

Allows an existing user to retrieve all his apps infos. Returns a JSON array of apps or an error text.


HTTP 200 : string POST/app/updateApp/{id}
Update App Infos

Allows an existing user to update the infos for one of his apps. Returns "1" in case of success, "false" otherwise. All the parameters are optional.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the app title.
Example: MyLovelyApp

titolo

Optional

string

This is the app language in a two (2) chars encoding.
Example: en

language

Optional

string

This is the app description.
Example: My lovely app description

descrizione

Optional

string

This contains the keywords of the app; multiple values must be separated by commas.
Example: my_company,my_name

keywords

Optional

string

This is the app URL for support.
Example: http://my_support_url

url_support

Optional

string

This is the app email for support.
Example: my_support_email@my_domain.com

email_support

Optional

string

This is the app category.
Example: Business

category

Optional

string

This contains the informations that will display when clicking on the "info button" of the app.
Example: This app is powered by myself

infos

Optional

string

This is the Android bundle name.
Example: myname.myapp

bundle_android

Optional

string

This is the Apple bundle name.
Example: myname.myapp

bundle_apple

Optional

string

This is the Google verification code.
Example: 123ABC

google_verification

Optional

string

This indicates if the app should be public or private (invisible to users). Possible respectively values: "1|0".
Example: 1

public

Optional

string

This is the app icon URL. Alternatively to the image URL, a FILE can be passed.
Example: http://my_icon_url

app_icon

Optional

string

This is the app splash image URL. Alternatively to the image URL, a FILE can be passed.
Example: http://my_splash_url

splash_image

Optional

string

This is the app privacy URL.
Example: http://my_privacy_url

privacy_url

Optional

string

This is the app DNS.

dns

Optional

string

This is the app phone number for support.
Example: 000111222

phone

Optional

HTTP 200 : string GET/app/upgradeApp/{id}
Upgrade App

Allows an existing user to make effective the changes made to the offline version of his app, copying them on the online version (visible by users).


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

App Settings

HTTP 200 : string GET/app/disableAuth/{id}
Disable App Auth

Allows an existing user to turn off access control on one of his apps.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string GET/app/setAuthInternal/{id}
Enable App Auth

Allows an existing user to turn on an access control on one of his apps.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string POST/app/setAuth/{id}
Enable Custom App Auth

Allows an existing user to turn on and set a Custom access control on one of his apps. How the Custom access control works: All the passed URLs should implement a login/check/logout/register login by themself. On each request an unique identifier is sent in the HTTP headers; the header name is X-APPSBUILDER-ID. Each passed URLs must return 1 on success and 0 on failure.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

Request Body

Authentication

HTTP 200 : string POST/auth/connect
Login AppsBuilder User

Allows an existing user to login on the AppsBuilder website. Notice: this function acts on AppsBuilder platform, not on CMS. Returns an object with keys "result" (with "true" in case of success, otherwise "false") and "access_token" (that contains the token needed for authentication HTTP header - see Readme page).


Test console
Description
Parameter
string

This is an existing username.
Example: my_username

username

Required

string

This is the password related to the existing username.
Example: my_password

password

Required

HTTP 200 : string POST/cms/connect
Login User

Allows an existing user to login. Returns an object with keys "result" (with "true" in case of success, otherwise "false") and "access_token" (that contains the token needed for authentication HTTP header - see Readme page).


Test console
Description
Parameter
string

This is an existing username.
Example: my_username

username

Required

string

This is the password related to the existing username.
Example: my_password

password

Required

string

This is the CMS ID where the user wants to login.
Example: 1

cms_id

Required

HTTP 200 : string GET/auth/logout
Logout AppsBuilder User

Allows an existing and logged in user to logout on the AppsBuilder website. Notice: this function acts on AppsBuilder platform, not on CMS.


HTTP 200 : string GET/cms/logout
Logout User

Allows an existing and logged in user to logout.


HTTP 200 : string POST/auth/register
Register AppsBuilder User

Allows a new user to register on the AppsBuilder website. Notice: this function acts on AppsBuilder platform, not on CMS. Returns "true" or a text error with failure reasons.


Test console
Description
Parameter
string

This is a valid username.
Example: my_username

username

Required

string

This is a valid password.
Example: my_password

password

Required

string

This is a valid email.
Example: my_email@my_domain.com

email

Required

string

This indicates if the user is automatically activated or it has to be, through the email link. Possible values: 1 (automatically activated), 0 (email link).
Example: 0

activate

Optional

string

This is an optional referer where the registration comes from.
Example: mywebsite

referer

Optional

HTTP 200 : string POST/cms/register
Register User

Allows a new user to register. Returns the newly created user ID (a number) or a text error with failure reasons.


Test console
Description
Parameter
string

This is a valid username.
Example: my_username

username

Required

string

This is a valid password.
Example: my_password

password

Required

string

This is a valid email.
Example: my_email@my_domain.com

email

Required

string

This is the CMS ID where the user wants to register.
Example: 1

cms_id

Required

Feeds

HTTP 200 : string POST/feedgenerator/add/{feed_id}
Add/Edit Feed Item

Allows an existing user to add or edit an item for one of his feeds. Returns the index of the newly created or edited item. More accurate informations can be found here: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types


Test console
Description
Parameter
string

This is the feed ID.
Example: 1

feed_id

Required

string

This is the item index. If set and existing, the item with this value will be updated with the new informations.
Example: 10

index

Optional

string

This is the item title.
Example: my_item_title

title

Optional

string

This is the item description.
Example: my_item_description

description

Optional

string

This is the item link.
Example: my_item_link

link

Optional

string

This is the item date. Default value: CURRENT_TIMESTAMP.
Example: my_item_date

data

Optional

string

This is the item latitude.
Example: my_item_latitude

latitude

Optional

string

This is the item longitude.
Example: my_item_longitude

longitude

Optional

string

This indicates if the item should be visible or not. Possible values are respectively: 1|0.
Example: 1

active

Required

string

This is the item thumbnail URL.
Example: http://my_item_thumbail

thumb

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

content

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

option

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

author

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

editor

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

phone

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

email

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

linkedin

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

twitter

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

facebook

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

street

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

city

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

cap

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

year

Optional

string

This value is used only on some feed types, and with different meanings. Please refer to the following page to have a detailed overview: https://appsbuilder.atlassian.net/wiki/display/res/Feed+Types

winery

Optional

string

This indicates if the e-commerce option should be enabled or not.
Example: 1

sale

Optional

string

This is the element price.
Example: 15

price

Optional

string

This is the price currency. Possible values: USD | EUR | GBP.
Example: EUR

currency

Optional

string

This indicates if the element is in discount or not.
Example: 0

discounted

Optional

string

This indicates whether the sale should be managed by AppsBuilder or externally.
Example: 0

internal

Optional

string

This is the url to externally manage the sale, in case of variable internal set to "0" .
Example: http://my_url

external_link

Optional

HTTP 200 : string POST/feedgenerator/createFeed
Create Feed

Allows an existing user to create a new feed. Returns the ID of the newly created feed, or an error message.


Test console
Description
Parameter
string

This is the name for the new feed.
Example: my_feed_name

name

Required

string

This value indicates how many items should be shown for this feed.
Example: 15

last

Optional

string

This is the new feed type. Possible values can be retrieved by using the method /feedgenerator/feedtypes.
Example: news

type

Required

HTTP 200 : string GET/feedgenerator/deleteFeed/{feed_id}
Delete Feed

Allows an existing user to delete one of his feeds. Returns "1" on success.


Test console
Description
Parameter
string

This is the feed ID.
Example: 1

feed_id

Required

HTTP 200 : string GET/feedgenerator/delete/{feed_id}/{item_id}
Delete Feed Item

Allows an existing user to delete an item for one of his feeds.


Test console
Description
Parameter
string

This is the feed ID.
Example: 1

feed_id

Required

string

This is the item ID.
Example: 10

item_id

Required

HTTP 200 : string POST/feedgenerator/modifyFeed/{feed_id}
Edit Feed

Allows an existing user to edit one of his feeds.


Test console
Description
Parameter
string

This is the feed ID.
Example: 1

feed_id

Required

string

This is the feed name.
Example: my_feed_name

name

Optional

string

This value indicates how many items should be shown for this feed.
Example: 15

last

Optional

string

This value indicates by which field the list should be sorted. Possible values: "title|data|index|geo".
Example: data

orderby

Optional

string

This value indicates the order direction. Possible values: "ASC|DESC".
Example: DESC

order

Optional

HTTP 200 : FeedItem GET/feedgenerator/getItems/{feed_id}
						[{
  "feed": "1",
  "index": "10",
  "active": "1",
  "content": "This is a textual content or an URL.",
  "data": "2012-10-10 10:10:10",
  "description": "my_item_description",
  "latitude": "my_item_latitude",
  "link": "my_item_link",
  "longitude": "my_item_longitude",
  "thumb": "http://my_item_thumbail",
  "title": "my_item_title"
}]						
Get Feed Content JSON

Allows an existing user to get the content of a feed. Returns a JSON array of feed items.


Test console
Description
Parameter
string

This is the feed ID.
Example: 1

feed_id

Required

HTTP 200 : string GET/feedgenerator/get/{feed_id}
Get Feed Content XML

Allows an existing user to get the content of a feed. Returns the XML format representation of the feed.


Test console
Description
Parameter
string

This is the feed ID.
Example: 1

feed_id

Required

HTTP 200 : FeedInfos GET/feedgenerator/getInfos/{feed_id}
						{
  "id": "1",
  "user": "10",
  "name": "My last feed",
  "type": "news",
  "last": "10",
  "order": "ASC",
  "orderby": "data",
  "data": "2012:20:12 23:59:59"
}						
Get Feed Infos

Allows an existing user to retrieve the informations for one of his feeds. Returns a JSON object.


Test console
Description
Parameter
string

This is the feed ID.
Example: 1

feed_id

Required

HTTP 200 : FeedSpec GET/feedgenerator/feedspec/{type}
Possible type values. "text": the user have to insert a short text value; "url": the user have to insert an url; "number": the user have to insert a number; "textarea": the user have to insert a medium/long text value; "rte": the user have to insert a medium/long text value with possibility to use html/css code; "image": the user have to select an image (the server is expecting an image URL), in this case the server needs also a POST variable named "thumb" that contains the URL of the thumbnail (not necessary for CMS and Website); "date": the user have to insert a date string; "checkbox|radio|select": the user should see the specific input type, the values of the inputs are found in the "values" key that is an hash which contains the real value as the key and the value to show as the value; "geo": the user have to insert a geolocalizated space, the server is expecting two POST variables "latitude" and "longitude", the application is free to help the user choose the coordinate in any ways.
						[{
  "name": "currency",
  "title": "Currency",
  "type": "select",
  "values": "{"USD":"Dollar","EUR":"Euro","GBP":"Pound"}"
}]						
Get Feed Specifications

Allows an existing user to retrieve the feed specification for a defined type. Returns a JSON array that describes the available fields for the feed item.


Test console
Description
Parameter
string

This is the feed type of which to retrieve the specification. Possible values can be retrieved by using the method /feedgenerator/feedtypes.
Example: news

type

Required

HTTP 200 : string GET/feedgenerator/feedtypes
Get Feed Types

Allows an existing user to retrieve a list of the available feed types. Returns a string with the possible types.


HTTP 200 : FeedInfos POST/feedgenerator/getfeeds
						[{
  "id": "1",
  "user": "10",
  "name": "My last feed",
  "type": "news",
  "last": "10",
  "order": "ASC",
  "orderby": "data",
  "data": "2012:20:12 23:59:59"
}]						
Get Feeds Infos

Allows an existing user to retrieve the informations for all his feeds, or for selected group of IDs. Returns a JSON array.


Test console
Description
Parameter
string

This is a list of feed IDs to return informations of. Multiple IDs must be separated by commas. It not passed the method returns the informations for all the user's feeds.
Example: 1,2,3

ids

Optional

Form Management

HTTP 200 : string GET/formgenerator/result/{form_id}/0/1
Get Form Results

Allows an existing user to retrieve the resulting data of a form requests. A CSV file will be returned.


Test console
Description
Parameter
string

This is the form ID, which can be obtained in the URL, when editing it on the platform.
Example: 1

form_id

Required

Helpers

HTTP 200 : FeedURLs GET/feedconverter/checkURL
Fields "feeds", "type", and "urltype" are optionally returned, based on their values.
						In case of error:
{
  "status": false
}
In case the passed URL is itself a feed:
{
  "status": true,
  "type": "xml",
  "urltype": "news"
}
In case the passed URL contains feed URLs:
{
  "feeds": [
    {
      "title": "A feed title",
      "url": "http://a_feed_url"
    }
  ],
  "status": true,
  "type": "site"
}						
Check Feed URL

Returns all the available feed contents from the passed URL


Test console
Description
Parameter
string

This is the URL to search the content from.
Example: http://your_url

url

Required

Layout

HTTP 200 : string POST/layout/deleteOption/{id}
Delete App Layoutoption Value

Allows an existing user to remove an app (first page) layoutoption value.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the name of the option to be removed.
Example: nrows

name

Required

HTTP 200 : LayoutHash GET/layout/getLayout/{id}
						{
  "layout": "String Value",
  "layoutoption": {
    "autoopen": 3,
    "banners": {
      "landscape": [
        {
          "type": "image",
          "url": "http://image_url",
          "width": "320",
          "height": "80"
        }
      ],
      "portrait": [
        {
          "type": "image",
          "url": "http://image_url",
          "width": "480",
          "height": "60"
        }
      ]
    },
    "cell_margin": [
      "5",
      "5",
      "5",
      "5"
    ],
    "colorscheme": {
      "col_even_bgalpha": 0.5,
      "col_even_bgcolor": "#FFFFFF",
      "col_odd_bgalpha": 0.5,
      "col_odd_bgcolor": "#FFFFFF",
      "row_even_bgalpha": 0.5,
      "row_even_bgcolor": "#FFFFFF",
      "row_odd_bgalpha": 0.5,
      "row_odd_bgcolor": "#FFFFFF"
    },
    "halign": "center",
    "hideDescription": 1,
    "hideTitle": 1,
    "ipadautoopen": 3,
    "nrows": 4,
    "rotate": true,
    "row_height": 100,
    "scroll": "horizontal",
    "valign": "middle",
    "width": 80,
    "win8": {
      "home_layout": "grouped",
      "page_layout": "tabs",
      "bgcolor": "#FFFFFF",
      "bgalpha": 0.5,
      "bgimg": "http://image_url",
      "icon_bgcolor": "#333333"
    }
  }
}						
Get App Layout

Allows an existing user to get one of his apps (first page) layout and layoutoption values. Returns a JSON hash containing those two values.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : string POST/layout/setLayout/{id}
Set App Layout

Allows an existing user to set the app (first page) a new layout and a new layoutoption object.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the new layout to be used for the app (first page). Possible values: "list|grid1|grid|grid3|grid4|grid5|lowpanel|fixedmenu".
Example: grid1

layout

Required

string

This is the new layoutoption object to be used for the app (first page). The value passed is an hash of type LayoutOption.
Example: LayoutOption

layoutoption

Required

HTTP 200 : string POST/layout/setLayoutOption/{id}
Set App Layoutoption

Allows an existing user to set new layoutoption values of the first page for one of his apps.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

number

If the layout is "fixedmenu", this indicates the index of the first page to open when the app is launched. If not present the first page is opened.
Example: 1

autoopen

Optional

string

This contains an array with 4 margin values, indicating respectively the cell top, right, bottom, left margins.
Example: ["5","5","5","5"]

cell_margin

Optional

string

This indicates the horizontal align for the elements container to the page. Used only if "width" is different from "100"(%). Possible values: "left|center|right".
Example: center

halign

Optional

number

If this key exists, the element description is set to an empty string.
Example: 1

hideDescription

Optional

string

If this key exists, the element title is set to an empty string.
Example: 1

hideTitle

Optional

string

On iPad, if the layout is different from "lowpanel", this indicates the index of the first page to open when the app is launched. If not present the first page is opened.
Example: 3

ipadautoopen

Optional

number

This indicates the number of rows visible for the elements container.
Example: 4

nrows

Optional

boolean

Defines if the app should rotate when used in landscape mode or not. If the key does not exist, the app will rotate.

rotate

Optional

number

This indicates the height of every rows of the elements container.
Example: 100

row_height

Optional

string

This indicates the scroll direction of the elements container, when scroll is needed. Possible values: "vertical|horizontal".
Example: horizontal

scroll

Optional

string

This indicates the vertical align for the elements container to the page. Used only if "nrows" is set. Possible values: "top|middle|bottom".
Example: middle

valign

Optional

number

This is the width of the elements container in percentage respect the page width. The value is a number, but must be interpreted as a percentage value.
Example: 80

width

Optional

HTTP 200 : string POST/layout/setOption/{id}/{option}
Set App Layoutoption Values

Allows an existing user to set new layoutoption values (only the ones that have a complex structure, for simple options see Set App Layoutoption) of the first page for one of his apps. The only possible options settable by this method are: "banner|banners|win8". The couples key-value passed as arguments will be inserted into the new specified option. The only admitted options are: "colorscheme|banners|win8".


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the name of the new option. Possible values: "colorscheme|banners|win8".
Example: win8

option

Required

string

This is a couple key-value that will be inserted in the new option.
Example: value_for_key_1

name_of_key_1

Required

string

This is a couple key-value that will be inserted in the new option (the request can have N couples).
Example: value_for_key_N

name_of_key_N

Required

HTTP 200 : string GET/layout/setRotation/{id}/{state}
Set App Rotation

Allows an existing user to enable or disable the rotation of one of his apps.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is a numeric value to disable or enable the app rotation. Possible (respectively) values: "0|1".
Example: 0

state

Required

Promote

HTTP 200 : string POST/app/addStore/{id}
Add Web Redirect To Mobile

Allows an existing user to set up, for one of his apps, a redirect script that can be used on a website to display a clickable message to visitors if a native version of the app is available based on their device OS. The script will be available at the following URL: http://www.apps-builder.com/libs/redirect/{id}.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the URL of the Google Play app page.
Example: https://play.google.com/...

android

Optional

string

This is the URL of the App Store app page.
Example: https://itunes.apple.com/...

apple

Optional

string

This is the URL of the Windows Marketplace app page.
Example: http://www.windowsphone.com/...

windows

Optional

Push Notifications

HTTP 200 : string POST/push/addAppleCertificate/{id}
Add APN Certificate

Allows an existing user to upload an Apple Push Notification Certificate for one of his apps.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

binary

This is the .p12 binary file, generated without any passwords set.
Example: the_p12_file

p12

Required

HTTP 200 : binary GET/push/getAppleCertificate/{id}
Get APN Certificate

Allows an existing user to download the previously uploaded Apple Push Notification Certificate for one of his apps. Returns the .p12 binary file if available, otherwise returns an empty file.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

HTTP 200 : PushNotificationMessage GET/push/story/{id}/{limit}
						[{
  "data": "2013-01-01 00:00:01",
  "message": "Happy new year!"
}]						
Get Sent Messages

Allows an existing user to retrieve the previously sent push notification messages for on of his apps, specifying the number of results to be shown.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the number of push notification messages to be shown.
Example: 10

limit

Required

HTTP 200 : string POST/push/add/{id}
Send Message

Allows an existing user to send a push notification message for one of his apps, to all devices using it. The message is added to the outgoing queue and could be considered surely delivered after 30 minutes from the sending time. Returns "success" or "error" for the respective state.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the message that will be added to the outgoing queue and delivered to the users.
Example: my_push_notification_message

message

Required

string

This is a Y-m-d H:i:s value at which the notification should be send. Use current time to send it as soon as possible.
Example: 2013-01-01 10:00:00

date

Required

string

This is an array of devices type for which the notification should be sent. Possible values: apple, android, windows.
Example: ['apple','android']

device

Optional

string

This is the latitude value to limit your notification delivery based on latitude, longitude and radius values.

latitude

Optional

string

This is the longitude value to limit your notification delivery based on latitude, longitude and radius values.

longitude

Optional

string

This is the radius value to limit your notification delivery based on latitude, longitude and radius values.

radius

Optional

Style

HTTP 200 : string POST/style/deleteStyle/{id}
Delete App Style

Allows an existing user to delete one of his apps style options.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is the name of the style option to be deleted.
Example: bg_menu_landscape_bgimg

style

Required

HTTP 200 : Style POST/style/getStyle/{id}
						{
  "bg2_alpha": 10,
  "bg2_bgcolor": "String Value",
  "bg2_menu_bb10_landscape": "String Value",
  "bg2_menu_bb10_portrait": "String Value",
  "bg2_menu_ipad2_bgimg": "String Value",
  "bg2_menu_ipad_bgimg": "String Value",
  "bg2_menu_landscape2_bgimg": "String Value",
  "bg2_menu_landscape_bgimg": "String Value",
  "bg2_menu_portrait2_bgimg": "String Value",
  "bg2_menu_portrait_bgimg": "String Value",
  "bg_alpha": 10,
  "bg_bgcolor": "String Value",
  "bg_menu_bb10_landscape": "String Value",
  "bg_menu_bb10_portrait": "String Value",
  "bg_menu_ipad2_bgimg": "String Value",
  "bg_menu_ipad_bgimg": "String Value",
  "bg_menu_landscape2_bgimg": "String Value",
  "bg_menu_landscape_bgimg": "String Value",
  "bg_menu_portrait2_bgimg": "String Value",
  "bg_menu_portrait_bgimg": "String Value",
  "cat_desc_alpha": 10,
  "cat_desc_color": "String Value",
  "cat_desc_font": "String Value",
  "cat_desc_font_android": "String Value",
  "cat_desc_font_apple": "String Value",
  "cat_desc_font_windows": "String Value",
  "cat_title_alpha": 10,
  "cat_title_color": "String Value",
  "cat_title_font": "String Value",
  "cat_title_font_android": "String Value",
  "cat_title_font_apple": "String Value",
  "cat_title_font_windows": "String Value",
  "defaultimg": "String Value",
  "feed_desc_alpha": 10,
  "feed_desc_color": "String Value",
  "feed_desc_font": "String Value",
  "feed_desc_font_android": "String Value",
  "feed_desc_font_apple": "String Value",
  "feed_desc_font_windows": "String Value",
  "feed_title_alpha": 10,
  "feed_title_color": "String Value",
  "feed_title_font": "String Value",
  "feed_title_font_android": "String Value",
  "feed_title_font_apple": "String Value",
  "feed_title_font_windows": "String Value",
  "footer_alpha": 10,
  "footer_bgimg": "String Value",
  "footer_next_img": "String Value",
  "footer_prev_img": "String Value",
  "footer_share_img": "String Value",
  "header2_1024_bgimg": "String Value",
  "header2_320_bgimg": "String Value",
  "header2_480_bgimg": "String Value",
  "header2_568_bgimg": "String Value",
  "header2_704_bgimg": "String Value",
  "header2_768_bgimg": "String Value",
  "header2_alpha": 10,
  "header2_back_img": "String Value",
  "header2_bgcolor": "String Value",
  "header2_option_img": "String Value",
  "header2_title_alpha": 10,
  "header2_title_color": "String Value",
  "header2_title_font": "String Value",
  "header2_title_font_android": "String Value",
  "header2_title_font_apple": "String Value",
  "header2_title_font_windows": "String Value",
  "header_1024_bgimg": "String Value",
  "header_320_bgimg": "String Value",
  "header_480_bgimg": "String Value",
  "header_568_bgimg": "String Value",
  "header_704_bgimg": "String Value",
  "header_768_bgimg": "String Value",
  "header_alpha": 10,
  "header_bgcolor": "String Value",
  "header_credits_img": "String Value",
  "header_menu_img": "String Value",
  "header_update_img": "String Value"
}						
Get App Style

Allows an existing user to get one of his app style values. To obtain the value for a KEY, pass that key as the "style" parameter. To obtain all the key-values available, pass "all_styles" as "style" parameter. Returns a JSON hash containing the set values.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

"all_styles" to obtain all available key-values, or a specific KEY name to obtain its value.
Example: all_styles

style

Required

HTTP 200 : string GET/style/getThemes
Get Themes

Allows a user to retrieve the list of available themes. Returns an hash of Themes.


HTTP 200 : string GET/style/getUserThemes
Get User Themes

Allows a user to retrieve its own custom Themes. Returns an hash of Themes.


HTTP 200 : string POST/style/replaceStyle/{id}
Replace App Style

Allows an existing user to replace previous style values for one of his apps. New values should be passed as a list of parameters, using the parameter name set to the style option name, and the parameter value set to the style option value.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is a couple key-value that will be inserted in as a new style option.
Example: value_for_key_1

name_of_key_1

Required

string

This is a couple key-value that will be inserted in as a new style option.
Example: value_for_key_N

name_of_key_N

Required

HTTP 200 : string POST/style/addStyle/{id}
Set App Style

Allows an existing user to set new style values for one of his apps. New values should be passed as a list of parameters, using the parameter name set to the style option name, and the parameter value set to the style option value.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

id

Required

string

This is a couple key-value that will be inserted in as a new style option.
Example: value_for_key_1

name_of_key_1

Required

string

This is a couple key-value that will be inserted in as a new style option.
Example: value_for_key_N

name_of_key_N

Required

HTTP 200 : string POST/style/setTheme/{app_id}
Set App Theme

Allows an existing user to set a new theme for one of his apps.


Test console
Description
Parameter
string

This is the app ID.
Example: 1

app_id

Required

string

This is the theme ID.
Example: 10

id

Required

Consume this API completely for free!


By joining the mashape API marketplace you can start using AppsBuilder API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.