Differences

This shows you the differences between two versions of the page.

--- tutorials:startup-api [2024/12/06 22:35] – [Start the API on non Windows systems] tim2
+++ tutorials:startup-api [2025/01/22 15:55] (current) – [Start GroIMP in API mode] Tim
@@ Line 1: / Line 1: @@
 ====== Start GroIMP in API mode ======
-Using the [[user-guide:additional_interfaces#application_programming_interface| GroIMP API]] it is possible to use GroIMP as a service, or from a remote server.
+Using the [[user-guide:additional_interfaces:api| GroIMP API]] it is possible to use GroIMP as a service, or from a remote server.
 ===== Installing the API plugin =====
@@ Line 15: / Line 15: @@
 ===== Creating a shortcut on Windows =====
-If you use windows and installed GroIMP using the installer, you should have a desktop shortcut, where you normally click on to start GroIMP.
+{{:tutorials:copy.png?direct&200 |}} If you use windows and installed GroIMP using the installer, you should have a desktop shortcut, where you normally click on to start GroIMP.
 To get the same for the API please duplicate (copy paste) the original one and rename it to "GroLink".
 Press right click on the new shortcut and select properties.
+{{ :tutorials:prefrences.png?direct&200|}}
 In the properties panel in the field Target, find the part "javaw.exe" and remove the "w" so it becomes "java.exe" (This will keep the ugly black command line window open). Additionally add at the very end of the content of the same filed " -a api" which instructs GroIMP to start the API.
-After applying this changes, you can now click on this short cut and start the API.
+For example if the original command was:
+<code>
+"C:\Program Files\Common Files\Oracle\Java\javapath\javaw.exe" -Xmx1500M -Xverify:none -jar core.jar
+</code>
+you would change it to:
+<code>
+"C:\Program Files\Common Files\Oracle\Java\javapath\java.exe" -Xmx1500M -Xverify:none -jar core.jar -a api
+</code>
+After applying this changes, you can now click on this short cut to start the API. This will also open the following window:
+{{ :tutorials:running.png?direct&600 |}}
+In this window you can see the port on which your API is running and later possible errors in the execution. If you close this window the API server is closed as well.
 ===== Start the API on non Windows systems =====