You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorials/api-workshop.md
+14-7Lines changed: 14 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,25 @@ title: API Workshop
5
5
6
6
# API Workshop
7
7
8
-
We created a workshop to get started with the HTTP REST API provided by eLabFTW.
8
+
This workshop introduces how to interact with the **eLabFTW REST API** using **Jupyter notebooks**. It provides a hands-on, step-by-step learning experience where you can execute requests, explore responses, and automate workflows directly from your browser or local environment.
9
+
10
+
The workshop is organized into multiple notebooks, guiding you from basic API concepts to practical usage with tools like `curl` and Python. It is designed for beginners as well as intermediate users who want to better understand and use the API in real scenarios.
11
+
12
+
You can run the notebooks:
13
+
-**Locally** with JupyterLab (recommended for full control)
14
+
-**Online** using Google Colab (no installation required)
15
+
16
+
Detailed setup instructions are available in the repository.
9
17
10
18
## Video
11
19
12
-
A recording of this workshop, suitable to beginners, is available in this video:
20
+
A full walkthrough of the workshopis available in the video below. It follows the same structure as the notebooks and demonstrates how to interact with the API step by step using Jupyter.
13
21
14
22
<iframewidth="560"height="315"src="https://www.youtube.com/embed/8Ag-saY47VE?si=XIRdtSBb00dXcRAo"title="eLabFTW API Workshop Video"frameborder="0"allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"referrerpolicy="strict-origin-when-cross-origin"allowfullscreen></iframe>
-[API Workshop repository](https://github.com/elabftw/api-workshop/?tab=readme-ov-file#elabftw-api-workshop) <br />➡️ Contains the Jupyter notebooks used in this workshop, along with setup instructions to run them locally or in Google Colab.
27
+
-[API endpoints documentation](https://doc.elabftw.net/api/v2/) <br />➡️ Reference documentation listing all available API endpoints, parameters, and expected responses.
28
+
-[Python library (elabapi-python)](https://github.com/elabftw/elabapi-python) <br />➡️ Official Python client to interact with the eLabFTW API without writing raw HTTP requests.
29
+
-[Python library HTML documentation](https://doc.elabftw.net/api/elabapi-html/) <br />➡️ Detailed documentation of the Python library, including available methods and usage examples.
0 commit comments