API

[Ngày cập nhật: 13/01/25]

Ghi chú:

Swagger API E-ra https://backend.eoh.io/swagger/

Document API E-ra https://backend.eoh.io/redoc/

1. Hướng dẫn lấy mã AUTHTOKEN

• Đăng nhập vào website: https://app.e-ra.io.

• Nhấp vào ảnh đại diện -> Chọn Profile.

Chọn profile E-Ra

• Copy mã AUTHTOKEN (Mã xác thực) phía dưới cùng.

Lưu ý thông tin AUTHTOKEN là thông tin quan trọng không được để lộ ra bên ngoài

2. Hướng dẫn cài đặt Authorizations trên swagger:

• Truy cập vào https://backend.eoh.io/swagger/ (Danh sách API của EoH).

Nhập Token (apiKey)

• Điền mã AUTHTOKEN -> Nhấn Authorize -> Nhấn Close.

• Như vậy là xong, bây giờ bạn có thể thực hành gọi các API có trong https://backend.eoh.io/swagger/.

Lưu ý thông tin AUTHTOKEN là thông tin quan trọng không được để lộ ra bên ngoài

3. Hướng dẫn thực hành gọi một số API trên EoH

Cần cài đặt Authorizations trước khi thực hành.

Các hướng dẫn dưới đây có sử dụng các thuật ngữ như config, end device,... Để hiểu rõ hơn về các thuật ngữ này, bạn có thể truy cập vào: Các khái niệm & Hướng dẫn tổng quan

Thực hành gọi API lấy giá trị hiện tại của config trên swagger

Cách 1:

• B1: Truy cập vào trang: https://backend.eoh.io/swagger/. Tìm đến API GET chip_manager/configs/. Để lấy danh sách config bạn đang có. Sau đó nhấn vào Try it out.

• B2: Nhấn vào Execute.

• B3: Bạn sẽ nhận được dữ liệu trả về từ API chip_manager/configs/ . Bao gồm nhiều thông tin của config vị dụ như id, name, unit, scale, ....

• B4: Sử dụng API /chip_manager/configs/{id}/current_value/ Để nhận giá trị hiện tại của config. Từ B3 ở trên API /chip_manager/configs/ đã trả về thông tin config id, ở đây mình lấy config id = 21973 làm ví dụ.

• B5: Như vậy là xong từ việc gọi API /chip_manager/configs/{id}/current_value/

  chúng ta đã có giá trị hiện tại của config current_value_only": 0.

Cách 2: Sử dụng công cụ dòng lệnh CURL.

• B1: Hãy kiểm tra xem CURL đã được cài đặt trên máy của bạn chưa bằng cách chạy lệnh curl --version trên terminal. Nếu không có thông báo lỗi nào xuất hiện, điều đó có nghĩa là CURL đã được cài đặt thành công. Ngược lại bạn cần tìm kiếm hướng dẫn cài đặt CURL trên mạng.

• B2: Bạn copy dòng lệnh curl trên swagger và chạy nó trên terminal của bạn.

• B3: Như vậy là xong từ việc sử dụng CURL chúng ta đã có giá trị hiện tại của config current_value_only": 0.

Thực hành gọi API điều khiển thiết bị trên swagger

Để điều khiển được thiết bạn cần có action key

• B1: Gọi API /property_manager/units/mine/. Để lấy thông tin device id.

• B2: Sau khi có device id bạn sử dụng API /property_manager/devices/{device_id}/display/. Để lấy action key.

Ví dụ chúng ta có:

action_on: c163e4a9-79a6-4ae5-9dd9-c5cf8377d3e3

action_off: dbd5b4d7-8c5c-485f-8aca-90474ffe9d84

• B3: Sau khi có action key bạn sử dụng API /chip_manager/trigger_action/ để điều khiển thiết bị.

Xin lưu ý rằng một số action key có thể không cần trường data. Nếu action của bạn cần truyền data, bạn có thể điều chỉnh thêm nếu cần thiết.