Conversions via API
Integrate our API into your organization and convert websites or web applications on demand into unique desktop applications.
Overview
Click on any chapter to jump there quickly.
Introduction
We offer a powerful 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
Use of our API is only possible with paid licenses.
API Call
To convert a website or web application into a desktop application or to update a converted desktop application, call https://website2desktop.com/api-call with valid API parameters.
On a valid API call, success is returned.
When you convert a website or web application into a desktop application using our API, two download links (setup file and license file) are sent to the specified email address within seconds of a valid API call. When you update a previously converted desktop application via our API, the selected settings are applied within seconds of a valid API call.
On an invalid API call, a specific error code such as e101 is returned. See all possible error codes here.
API Parameters
To convert a website or web application, use type create. To update an existing application, use type update. See our other pages (e.g. Pricing or Enterprise Conversion) for details on most parameters. Please swipe left and right within the table.
|
Parameter Name
|
Possible Values
|
Notes
|
|---|---|---|
| type | create, update | - |
| license | [String] | 53 characters |
| password | [String] | only when type = update; password stored in login area |
| lang | de, en, fr, it, es, pt, ru, ro, tr, da, nl, pl | - |
| firstname | [String] | - |
| lastname | [String] | - |
| [String] | - | |
| app_type | l, p, e | l = Lite, p = Pro, e = Enterprise |
| app_icon | [HTTP Link] | PNG file only; max. 1 MB |
| app_name | [String] | - |
| app_url | [HTTP Link] | - |
| 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 blank |
| app_windowsize_custom_height | [Number] | Only if app_windowsize = 1; otherwise leave blank |
| 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 |
| Lite parameters | ||
| app_deactivate_minimize | 1, 2 | 1 = Yes, 2 = No |
| app_deactivate_maximize | 1, 2 | 1 = Yes, 2 = No |
| browser_deactivate_scrollbars | 1, 2 | 1 = Yes, 2 = No |
| Pro parameters | ||
| 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 blank; number between 0.5 – 3.0 |
| more_password | 1, 2 | 1 = Yes, 2 = No |
| more_password_detail | [String] | Only if more_password = 1; otherwise leave blank |
| more_trial | 1, 2 | 1 = Yes, 2 = No |
| more_trial_detail | [Number] | Only if more_trial = 1; otherwise leave blank |
| more_splash | 1, 2 | 1 = Yes, 2 = No |
| more_splash_file | [HTTP Link] | Only if more_splash = 1; otherwise leave blank; PNG file only; max. 1 MB |
| Enterprise parameters | ||
| app_block_copy | 1, 2 | 1 = Yes, 2 = No |
| app_block_paste | 1, 2 | 1 = Yes, 2 = No |
| 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_block_multistart | 1, 2 | 1 = Yes, 2 = No |
API Errors
If an API call fails, an error code consisting of the letter e and a specific number is returned. Below is a full list of possible error codes. Please swipe left and right within the table.
|
Error Code
|
Meaning
|
|---|---|
| e100 | Internal critical error |
| e101 | Exceeded limit of 20 requests per minute |
| e102 | Urgent maintenance |
| 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: more_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 |
API Example 1
Simple example of a create API call using a Lite license:
API Example 2
Simple example of a create API call using an Enterprise license:
API Example 3
Simple example of an update API call using an Enterprise license:
Do you need support?
We’re happy to help you integrate our API. Please contact our support team.