Overview
Click on any chapter to jump there quickly.
Introduction
We offer a powerful Web API to enable businesses and developers to perform fast, on-demand conversions of websites and web applications into desktop applications. In addition to converting websites and web applications, converted desktop applications can be conveniently and easily updated via our API.
By using our API, businesses and developers agree to our Privacy Policy and our Terms of Use.
Licenses
The use of our API is possible with both free and paid licenses. Please note that the conversion of websites and web applications is only available with paid licenses.
API Call
To convert a website or web application into a desktop application, or to update an already converted desktop application, please send a request to https://website2desktop.com/api-call with valid API parameters.
When you convert a website or web application into a desktop application via our API, two download links (setup file & license file) will be sent to the specified email address within a few seconds after a valid API call. When you update a converted desktop application via our API, the selected settings will be updated within a few seconds after a valid API call.
For a valid API call, success will be returned. In case of an invalid API call, a specific error code such as e101 will be returned. You can find all possible error codes here.
API Parameters
To convert a website or web application into a desktop application, please use the type create. To update the settings of an existing desktop application, please use the type update. Further details about most parameters can be found on the main page.
|
Name
|
Possible Values
|
Notes
|
|---|---|---|
| type | create, update | - |
| license | [string] | 53 characters |
| password | [string] | only if type = update; password stored in the customer area |
| lang | en | - |
| firstname | [string] | - |
| lastname | [string] | - |
| [string] | - | |
| app_type | f, p | f = Free, p = Pro |
| app_icon | [string] | URL; PNG file only; maximum 1 MB |
| app_name | [string] | - |
| app_url | [string] | URL |
| app_os | 1, 2, 3 | 1 = Windows, 2 = MacOS (Universal Binary), 3 = MacOS (Silicon) |
| app_windowsize | 1, 2, 3 | 1 = Custom size, 2 = Maximized, 3 = Fullscreen |
| app_windowsize_custom_width | [number] | Only if app_windowsize = 1, otherwise leave empty |
| app_windowsize_custom_height | [number] | Only if app_windowsize = 1, otherwise leave empty |
| app_change_size | 1, 2 | 1 = Yes, 2 = No |
| app_window_minimize | 1, 2 | 1 = Yes, 2 = No |
| app_always_front | 1, 2 | 1 = Yes, 2 = No |
| app_deactivate_minimize | 1, 2 | 1 = Yes, 2 = No |
| app_deactivate_maximize | 1, 2 | 1 = Yes, 2 = No |
| app_block_copy | 1, 2 | 1 = Yes, 2 = No |
| app_block_paste | 1, 2 | 1 = Yes, 2 = No |
| app_block_multistart | 1, 2 | 1 = Yes, 2 = No |
| browser_deactivate_scrollbars | 1, 2 | 1 = Yes, 2 = No |
| browser_incognito | 1, 2 | 1 = Yes, 2 = No |
| browser_zoom | 1, 2 | 1 = Yes, 2 = No |
| browser_zoom_power | [number] | Only if browser_zoom = 1, otherwise leave empty; number between 0.5 - 3.0 |
| browser_deactivate_scroll_animation | 1, 2 | 1 = Yes, 2 = No |
| browser_block_audio | 1, 2 | 1 = Yes, 2 = No |
| browser_block_images | 1, 2 | 1 = Yes, 2 = No |
| browser_block_cookies | 1, 2 | 1 = Yes, 2 = No |
| browser_block_local_storage | 1, 2 | 1 = Yes, 2 = No |
| browser_block_plugins | 1, 2 | 1 = Yes, 2 = No |
| browser_block_javascript | 1, 2 | 1 = Yes, 2 = No |
| browser_block_insecure_content | 1, 2 | 1 = Yes, 2 = No |
| browser_block_domains | 1, 2 | 1 = Yes, 2 = No |
| more_password | 1, 2 | 1 = Yes, 2 = No |
| more_password_detail | [string] | Only if more_password = 1, otherwise leave empty |
| more_trial | 1, 2 | 1 = Yes, 2 = No |
| more_trial_detail | [number] | Only if more_trial = 1, otherwise leave empty |
| more_splash | 1, 2 | 1 = Yes, 2 = No |
| more_splash_file | [string] | URL; only if more_splash = 1, otherwise leave empty; PNG file only; maximum 1 MB |
| more_statistics | 1, 2 | 1 = Yes, 2 = No |
| more_statistics_endpoint | [string] | URL; only if more_statistics = 1, otherwise leave empty |
API Errors
If an API call fails, an error code in the format e### will be returned. Below you can find a complete list of possible error codes.
|
Error Code
|
Meaning
|
|---|---|
| e100 | Internal, critical error |
| e101 | Limit of 20 requests per minute exceeded |
| e102 | Urgent maintenance work |
| e103 | [Reserved for future updates] |
| e104 | [Reserved for future updates] |
| e105 | [Reserved for future updates] |
| e106 | [Reserved for future updates] |
| e107 | [Reserved for future updates] |
| e108 | [Reserved for future updates] |
| e109 | [Reserved for future updates] |
| e110 | Invalid parameter: type |
| e111 | Invalid parameter: app_type |
| e112 | Invalid parameter: license |
| e113 | Invalid parameter: lang |
| e114 | Invalid parameter: app_icon |
| e115 | Invalid parameter: firstname |
| e116 | Invalid parameter: lastname |
| e117 | Invalid parameter: email |
| e118 | Invalid parameter: app_name |
| e119 | Invalid parameter: app_url |
| e120 | Invalid parameter: app_os |
| e121 | Invalid parameter: app_windowsize |
| e122 | Invalid parameter: app_change_size |
| e123 | Invalid parameter: app_window_minimize |
| e124 | Invalid parameter: app_always_front |
| e125 | Invalid parameter: app_deactivate_minimize |
| e126 | Invalid parameter: app_deactivate_maximize |
| e127 | Invalid parameter: browser_deactivate_scrollbars |
| e128 | Invalid parameter: browser_incognito |
| e129 | Invalid parameter: browser_zoom |
| e130 | Invalid parameter: browser_zoom_power |
| e131 | Invalid parameter: more_password |
| e132 | Invalid parameter: more_password_detail |
| e133 | Invalid parameter: more_trial |
| e134 | Invalid parameter: more_trial_detail |
| e135 | Invalid parameter: more_splash |
| e136 | Invalid parameter: more_splash_file |
| e137 | Invalid parameter: browser_block_cookies |
| e138 | Invalid parameter: app_block_copy |
| e139 | Invalid parameter: app_block_paste |
| e140 | Invalid parameter: app_block_multistart |
| e141 | Invalid parameter: browser_block_audio |
| e142 | Invalid parameter: browser_block_javascript |
| e143 | Invalid parameter: browser_block_local_storage |
| e144 | Invalid parameter: browser_block_plugins |
| e145 | Invalid parameter: browser_block_insecure_content |
| e146 | Invalid parameter: browser_deactivate_scroll_animation |
| e147 | Invalid parameter: browser_block_images |
| e148 | Invalid parameter: browser_block_domains |
| e149 | Invalid parameter: more_statistics |
| e150 | Invalid parameter: more_statistics_endpoint |
API Example 1
Example of an API call of type create.
API Example 2
Example of an API call of type update.
Do you need support?
We’re happy to help you integrate our API. Please contact our customer support.