Differences

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

--- tutorials:startup-api [2024/12/06 21:47] – created 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 ======
+===== Installing the API plugin =====
-The API can be installed using the [[:user-guide:pluginmanager|plugin manager]]
+The API can be installed using the [[:user-guide:pluginmanager|plugin manager]], to do so please go on help / plugin manager and select under available plugins the plugin API and press the apply button.
+If you want to install the API on a system without a visual user interface you can run the following command:
+<code bash>
+java -jar core.jar --headless -- -cmd /pluginmanager/commands/installCMD=de.grogra.api
+</code>
+===== Creating a shortcut on Windows =====
+{{: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.
+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 =====
+To run the API on other devices you have to execute java directly, for example on Ubuntu you can run:
+<code bash>
+java  -Xverify:none -jar /usr/share/GroIMP/core.jar -a api
+</code>
+If you are working on a system without graphics you also have to add ''--headless''.
+===== Testing the connection =====
+After starting the API you can now test it using your web browser. Just go on [[http://localhost:58081/api/app/ui/commands/app/create?newRGG]] and you should see a short text such as {"id":"1"}.
+Now you are ready to go with:
+  * [[:tutorials:getting-started-with-grolink-and-http|HTTP]]
+  * [[:tutorials:getting-started-with-grolink-and-gropy|Python]]
+  * [[:tutorials:getting-started-with-grolink-and-gror|R]]
+Or one of the [[https://gitlab.com/groimp-api-examples/|examples]]
+===== Stopping the API =====
+To stop the API you can just press ctr+c in the console or close the console.