Differences

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

--- 01_user_documentation:groimp-platform:interfaces:api [2025/01/24 17:05] – ↷ Links adapted because of a move operation gaetan
+++ 01_user_documentation:groimp-platform:interfaces:api [2025/01/24 17:06] (current) – removed gaetan
@@ Line 1: / Line 1: @@
-===== API GroIMP =====
-With the use of the GroLink Project GroIMP can be started as an API server, that can handle Http-requests.
-==== Get started ====
-Starting with GroIMP 2.1 the API application is included and can be started with the following command:
-> java -Xverify:none -jar core.jar %%--%%headless -a api
-This starts a local web server, the default port is 58081, this can be changed either in the preferences panel in the GUI or by adding ''-Xport=58080'' to the command above.
-A more in-depth explanation of GroIMP arguments can be found [[01_user_documentation:user-guide:advanced-groimp-arguments|here]].
-Now the API can be reached at [[http://localhost:58081/api|http://localhost:58081/api]]. This will return an error message since no command was given.
-While the API is running, it is possible to send the commands defined in the [[https://gitlab.com/grogra/groimp-plugins/api|plugin]] directly or by using a client library. For now, there are libraries in [[https://gitlab.com/grogra/groimp-utils/pythonapilibrary|python]]  and [[https://gitlab.com/grogra/groimp-utils/rapilibrary|R]].
-==== Tutorials ====
-  * [[02_user_tutorials:07_additional_interfaces:api:03_getting-started-with-grolink-and-gropy|getting started with GroLink and Python(GroPy)]]
-  * [[02_user_tutorials:07_additional_interfaces:api:04_getting-started-with-grolink-and-gror|getting started with GroLink and R(GroR)]]
-  * [[02_user_tutorials:07_additional_interfaces:api:02_getting-started-with-grolink-and-http|getting started with GroLink and HTTP in your web browser]]
-  * [[02_user_tutorials:07_additional_interfaces:api:05_handeling-data-in-grolink-projects|Handling data in GroLink projects]]
-==== Examples ====
-  * [[https://gitlab.com/groimp-api-examples/pythonnotebook|Python Notebook]]
-  * [[https://gitlab.com/groimp-api-examples/forester-game|Godot Game]]
-  * [[https://gitlab.com/groimp-api-examples/apiplus|example Addition]]