Integrate
Imeji can be easily integrated in your diverse data management workflows - no matter how your data are created and where your data are stored, you can:
- import or reference data into existing instance of imeji
- enrich data with additional metadata
- organize data into collections and albums
- create your own great clients which manage or display imeji data from within your web pages, applications or Apps
For this purpose, apart from the web interface of the imeji instance, you may use the JSON based REST API or the pyimeji Python client to create, edit and upload data. In addition, any Android-based smart device equipped with the **MPDL LabCam **app can become your personal mobile imeji device.
The imeji REST API allows you to create, retrieve, update or delete collections, items, albums or metadata profiles i.e. templates for description of your data. To integrate your applications or data workflows with imeji, this is the right place to start. Before proceeding with any coding activities, you may want to check our Swagger documentation and web interface or the full API documentation. To use the REST API you will need a running imeji service (instance). You may use following urls to reach it:
Note: replace 'demo.imeji.org' below with the domain of the imeji service you want to use
-
imeji web application http://demo.imeji.org/imeji/
-
REST API web interface (Swagger) http://demo.imeji.org/imeji/rest-doc/index.html
-
REST API base url http://demo.imeji.org/imeji/rest
-
REST API documentation https://github.com/imeji-community/imeji/wiki/A_Home-imeji-API-V1
For everyone who prefers working with Python or a command line pyimeji python package is the right tool to integrate with imeji. You may download it from the Python Package Index, via pip or simply, clone it from GitHub. pyimeji is a wrapper for the REST API and supports all create, retrieve, update, delete operations for all imeji resources. You may interact with imeji from the command line, python console or your code (if it supports python). For more information check out:
- pyimeji documentation http://pyimeji.readthedocs.io/en/latest/index.html
- pyimeji in the Python Package Index https://pypi.python.org/pypi/pyimeji
- pyimeji on GitHub https://github.com/imeji-community/pyimeji
pyimeji has been proven in uploading and updating of data for the MPDL Outbox service as well as a component used to upload data via MATLAB.
If you want to capture and transfer data which reside on your (Android) mobile device to imeji, download and install the LabCam App! It does not require any technical knowledge, apart from the url of the running imeji service you would like to connect to and your credentials for the service. You may work in automatic or manual upload mode - and be sure your data are captured and preserved in a trusted storage offered by your imeji service. From the imeji service you can get your own personal QR-Code and use it to log-in to your imeji service from the LabCam. Try it!
- LabCam documentation http://labcam.mpdl.mpg.de/
- LabCam installation http://labcam.mpdl.mpg.de/install-mpdl-cam/