MyEMS能源管理系统v1.2.3

# MyEMS API Service ## Introduction Providing REST API service for [MyEMS](https://github.com/MyEMS/myems) components and third parties. ## Prerequisites anytree simplejson mysql.connector falcon falcon_cors gunicorn openpyxl ## Installation In this step, you will install myems-api on Ubuntu for production or development. For macOS developers, please refer to [Installation on macOS (Chinese)](./installation_macos_zh.md) * Install anytree ```bash cd ~/tools git clone https://github.com/c0fec0de/anytree.git cd anytree sudo python3 setup.py install ``` * Install simplejson ```bash cd ~/tools git clone https://github.com/simplejson/simplejson.git cd simplejson sudo python3 setup.py install ``` * Install MySQL Connector ```bash cd ~/tools wget https://dev.mysql.com/get/Downloads/Connector-Python/mysql-connector-python-8.0.20.tar.gz tar xzf mysql-connector-python-8.0.20.tar.gz cd ~/tools/mysql-connector-python-8.0.20 sudo python3 setup.py install ``` * Install Falcon, if you are behind proxy, use --proxy parameter Refer to https://falconframework.org/ https://github.com/lwcolton/falcon-cors https://github.com/yohanboniface/falcon-multipart ```bash mkdir ~/tools/falcon && cd ~/tools/falcon pip3 download cython falcon falcon-cors falcon-multipart export LC_ALL="en_US.UTF-8" export LC_CTYPE="en_US.UTF-8" sudo dpkg-reconfigure locales sudo pip3 install --upgrade --no-index --find-links ~/tools/falcon cython falcon falcon-cors falcon-multipart ``` * Install gunicorn, refer to http://gunicorn.org ```bash mkdir ~/tools/gunicorn && cd ~/tools/gunicorn pip3 download gunicorn sudo pip3 install --no-index --find-links ~/tools/gunicorn gunicorn ``` * Install openpyxl, refer to https://foss.heptapod.net/openpyxl/openpyxl Get the latest version of et_xmlfile from https://foss.heptapod.net/openpyxl/et_xmlfile Get the latest version of jdcal from https://github.com/phn/jdcal Get the latest version of openpyxl from https://foss.heptapod.net/openpyxl/openpyxl ```bash cd ~/tools wget https://foss.heptapod.net/openpyxl/et_xmlfile/-/archive/branch/default/et_xmlfile-branch-default.tar.gz tar xzf et_xmlfile-branch-default.tar.gz cd ~/tools/et_xmlfile-branch-default sudo python3 setup.py install cd ~/tools git clone https://github.com/phn/jdcal.git cd ~/tools/jdcal sudo python3 setup.py install mkdir ~/tools/pillow && cd ~/tools/pillow pip3 download Pillow sudo pip3 install --no-index --find-links ~/tools/pillow Pillow cd ~/tools wget https://foss.heptapod.net/openpyxl/openpyxl/-/archive/branch/3.0/openpyxl-branch-3.0.tar.gz tar xzf openpyxl-branch-3.0.tar.gz cd openpyxl-branch-3.0 sudo python3 setup.py install ``` * Download myems: ```bash cd ~ git clone https://github.com/MyEMS/myems.git ``` * Install gunicorn service for myems-api: ```bash cd ~/myems/myems-api sudo cp -R ~/myems/myems-api /myems-api ``` Change the config file: Note: change cookie domain to the actual domain or IP address of Web UI and Admin UI ```bash sudo nano /myems-api/config.py ``` Change the listening port (default is 8000) in gunicorn.socket: ```bash sudo nano /myems-api/myems-api.socket ``` ```bash ListenStream=0.0.0.0:8000 ``` ```bash sudo ufw allow 8000 ``` Setup systemd configure files: ```bash sudo cp /myems-api/myems-api.service /lib/systemd/system/ sudo cp /myems-api/myems-api.socket /lib/systemd/system/ sudo cp /myems-api/myems-api.conf /usr/lib/tmpfiles.d/ ``` Next enable the services so that they autostart at boot: ```bash sudo systemctl enable myems-api.socket sudo systemctl enable myems-api.service ``` Start the services : ```bash sudo systemctl start myems-api.socket sudo systemctl start myems-api.service ``` ## Run for debugging and testing ```bash cd myems-api sudo gunicorn -b 127.0.0.1:8000 app:api ``` ## API List View in Postman: import the file MyEMS.postman_collection.json with Postman [Energy Category](#Energy-Category) | [Energy Item](#Energy-Item) [Data Source](#Data-Source) | [Point](#Point) [Tariff](#Tariff) | [Cost Center](#Cost-Center) | [Cost File](#Cost-File) [Meter](#Meter) | [Virtual Meter](#Virtual-Meter) | [Offline Meter](#Offline-Meter) | [Offline Meter File](#Offline-Meter-File) [Space](#Space) | [Tenant](#Tenant) | [Tenant Type](#Tenant-Type) | [Store](#Store) | [Store Type](#Store-Type) | [Shopfloor](#Shopfloor) [Equipment](#Equipment) | [Combined Equipment](#Combined-Equipment) [Energy Flow Diagram](#Energy-Flow-Diagram) [Distribution System](#Distribution-System) | [Distribution Circuit](#Distribution-Circuit) [Rule](#Rule) | [Email Message](#Email Message) | [Text Message](#Text Message) | [Web Message](#Web Message) | [Wechat Message](#Wechat Message) [Email Server](#Email Server) | [GSM Modem](#GSM Modem) [User](#User) | [Privilege](#Privilege) | [Contact](#Contact) | [Notification](#Notification) [Timezone](#Timezone) [Menu](#Menu) [Knowledge File](#Knowledge-File) [Reports](#Reports) ### Contact * GET Contact by ID ```bash curl -i -X GET {{base_url}}/contacts/{id} ``` * GET All Contacts ```bash curl -i -X GET {{base_url}}/contacts ``` * DELETE Contact by ID ```bash curl -i -X DELETE {{base_url}}/contacts/{id} ``` * POST Create a New Contact ```bash curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"albert", "email":"albert@myems.io", "phone":"+8613888888888", "description":"contact description"}}' {{base_url}}/contacts ``` * PUT Update a Contact ```bash curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"albert", "email":"albert@myems.io", "phone":"+8613888888899", "description":"contact description"}}' {{base_url}}/contacts/{id} ``` ### Cost Center * GET Cost Center by ID ```bash curl -i -X GET {{base_url}}/costcenters/{id} ``` Result in JSON | Name | Data Type | Description | |---------------|-----------|-------------------------------------------| | id | integer | Cost Center ID | | name | string | Cost Center name | | uuid | string | Cost Center UUID | | external_id | string | Cost Center External ID ( For example, ID in SAP, ERP...) | * GET all Cost Centers ```bash curl -i -X GET {{base_url}}/costcenters ``` * DELETE Cost Center by ID ```bash curl -i -X DELETE {{base_url}}/costcenters/{id} ``` * POST Create New Cost Center ```bash curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"name":"动力中心", "external_id":"21829198980001"}}' {{base_url}}/costcenters ``` * PUT Update a Cost Center ```bash curl -i -H "Content-Type: application/json" -X PUT -d '{"data":{"name":"动力中心2", "external_id":"21829198980002"}}' {{base_url}}/costcenters/{id} ``` * GET All Tariffs associated with Cost Center ID ```bash curl -i -X GET {{base_url}}/costcenters/{id}/tariffs ``` * POST Create a Cost Center and Tariff Relation ```bash curl -i -H "Content-Type: application/json" -X POST -d '{"data":{"tariff_id":"3"}}' {{base_url}}/costcenters/{id}/tariffs ``` * DELETE a Cost Center and Tariff Relation by tid ```bash curl -i -X DELETE {{base_url}}/costcenters/{id}/tariffs/{tid} ``` ### Cost File * GET an Cost File by ID ```bash curl -i -X GET {{base_url}}/costfiles/{id} ``` Result | Name | Data Type | Description | |---------------|-----------|-------------------------------------------| | id | integer | Cost File ID | | file_name | string | Cost File name | | uuid | string | Cost File UUID | | upload_datetime | float | the number of milliseconds since January 1, 1970, 00:00:00, universal time | | status | string | Cost File processing status (new, done, error) | | file_object | BLOB | Cost File Object | * GET All Cost