Application

Create

Create a new application by providing at least a name and a user identifier.

<?php

$endpoint = "http://www.domain.com/application/api/create"

{
    "name": "My App",
    "key": "my-app",
    "font_family": "Helvetica"
}

Param	Type	Details	Default
name *	string	Application name
user_id *	int	Owner unique identifier
key	string	Application Key - Must be unique (e.g. http://www.domain.com/my-key)
font_family	string	Arial, Helvetica, Verdana, Georgia, Times new roman, Palatino
domain	string	(e.g. m.domain.com)
is_active	boolean	Render the application invisible from the editor	true
is_locked	boolean	Activate or deactivate the application	true

* Required fields

{
    "success": 1,
    "app_id": 1,
    "app_url": "http://www.domain.com/my-app"
}

{
    "error": 1,
    "message": "The key is already used by another application."
}

Param	Type	Details	Default
success/error	int	Indicate whether there was an error during the process	1
app_id	int	Application unique identifier - Used to update the app or to link a user to an app
app_url	string	URL of the application

Update an existing user.

<?php

$endpoint = "http://www.domain.com/application/api/update"

{
    "name": "My Stunning App",
    "key": "my-stunning-app",
    "font_family": "Arial"
}

Param	Type	Details	Default
app_id *	int	Unique identifier
name	string	Application name
key	string	Application key - Must be unique (e.g. http://www.domain.com/my-key)
font_family	string	Arial, Helvetica, Verdana, Georgia, Times new roman, Palatino
domain	string	(e.g. m.domain.com)
is_active	boolean	Render the application invisible from the editor	true
is_locked	boolean	Activate or deactivate the application	true

* Required fields

{
    "success": 1,
    "app_id": 1,
    "app_url": "http://www.domain.com/my-stunning-app"
}

{
    "error": 1,
    "message": "The key is already used by another application."
}

Param	Type	Details	Default
success/error	int	Indicate whether there was an error during the process	1
app_id	int	Application unique identifier - Used to update the app or to link a user to an app
app_url	string	URL of the application

Allows an existing user to manage an application.

<?php

$endpoint = "http://www.domain.com/application/api_admin/add"

{
    "app_id": "1",
    "user_id": "1"
}

Param	Type	Details
app_id *	int	Unique identifier
admin_id *	int	User identifier

* Required fields

{
    "success": 1
}

{
    "error": 1,
    "message": "This user can already manage this application."
}

Param	Type	Details	Default
success/error	int	Indicate whether there was an error during the process	1

Denies an existing user to manage an application.

<?php

$endpoint = "http://www.domain.com/application/api_admin/remove"

{
    "app_id": "1",
    "user_id": "1"
}

Param	Type	Details
app_id *	int	Unique identifier
admin_id *	int	User identifier

* Required fields

{
    "success": 1
}

{
    "error": 1,
    "message": "This user can't manage this application."
}

Param	Type	Details	Default
success/error	int	Indicate whether there was an error during the process	1