Tài liệu
Mọi lời gọi đi qua gateway bằng API key của trang trại.
| Môi trường | Địa chỉ gốc |
|---|---|
| Production | https://api-prod.nextfarm.vn |
Bắt đầu nhanh
Từ con số 0 tới lần gọi API đầu tiên trong 5 bước — chủ trại hoặc đối tác.
API key và scope
Header, 22 scope, giới hạn an toàn, error code.
Webhook
3 sự kiện, tin mẫu, verify signature, lịch retry.
MCP cho trợ lý AI
Nối trợ lý AI bất kỳ, 32 công cụ (chỉ đọc).
Bảo mật
Chứng từ, scope tối thiểu, signature HMAC-SHA256, HTTPS, xoay khoá, báo lỗ hổng.
Ứng dụng & OAuth
Làm phần mềm cho nhiều trại: tạo app, liên kết cài trả code, Test Console, Publish.
Error code
Mã HTTP, error code, nguyên nhân và cách sửa.
Rate limit
600 lượt/phút cho mỗi app × trại / API key, X-RateLimit-*, 429.
Tham chiếu API — 146 thao tác
/api/v1/gisThửa đất, vùng, nông dân, mùa vụ, lớp bản đồ — nền dữ liệu không gian của trang trại.
- GET/api/v1/gis/care-schedules— Các kích hoạt lịch chăm sóc (lọc theo thửa)
- GET/api/v1/gis/care-schedules/preview— Xem trước lịch (không ghi gì)
- GET/api/v1/gis/care-schedules/this-week— Việc chăm sóc tuần này (chỉ kích hoạt đang BẬT)
- GET/api/v1/gis/care-schedules/{id}/calendar— Lịch cả năm của một kích hoạt
- GET/api/v1/gis/care-schedules/{id}/generations— Lịch sử đã sinh của một kích hoạt
- GET/api/v1/gis/crop-types— Danh sách loại cây trồng
- GET/api/v1/gis/crop-types/{id}— Một loại cây trồng theo mã
- GET/api/v1/gis/crop-types/{id}/perennial-profile— Hồ sơ cây lâu năm của loài
- GET/api/v1/gis/crop-types/{id}/varieties— Giống và gốc ghép của loài
- GET/api/v1/gis/facilities— Danh sách chuồng trại
- GET/api/v1/gis/facilities/{id}— Chi tiết chuồng trại
- GET/api/v1/gis/farmer-groups— GET /api/v1/gis/farmer-groups
- GET/api/v1/gis/farmers— Danh sách nông dân
- GET/api/v1/gis/farmers/{id}— Chi tiết nông dân
- GET/api/v1/gis/layers— Danh sách map layers
- GET/api/v1/gis/layers/{id}— Chi tiết map layer
- GET/api/v1/gis/map/points— Điểm nhẹ theo bbox: nhà hộ dân + tâm thửa
- GET/api/v1/gis/parcels— Danh sách lô thửa
- GET/api/v1/gis/parcels/summary— Tổng hợp diện tích thửa theo hộ / vùng / cây
- GET/api/v1/gis/parcels/{id}— Chi tiết lô thửa
- GET/api/v1/gis/parcels/{id}/contains-point— Điểm GPS có nằm trong ranh thửa không
- GET/api/v1/gis/parcels/{id}/history— Lịch sử thay đổi parcel
- GET/api/v1/gis/parcels/{parcelId}/photos— Danh sách ảnh của lô thửa
- GET/api/v1/gis/plots— Danh sách khu của một thửa
- GET/api/v1/gis/plots/{id}/crops— Các loài trồng trong khu (trồng xen)
- GET/api/v1/gis/search— Tìm thửa, mùa vụ, nông dân, vùng
- GET/api/v1/gis/season-templates— Danh sách quy trình mẫu
- GET/api/v1/gis/season-templates/{id}— Một quy trình mẫu
- GET/api/v1/gis/seasons— Danh sách mùa vụ
- GET/api/v1/gis/seasons/groups— Nhóm vụ của một năm (cùng cây, cùng tên vụ)
- GET/api/v1/gis/seasons/{id}— Một mùa vụ theo mã
- GET/api/v1/gis/zones— Danh sách zones
- GET/api/v1/gis/zones/{id}— Chi tiết zone
- GET/api/v1/gis/zones/{id}/stats— Thống kê zone
/api/v1/iotThiết bị, số đo cảm biến, cảnh báo, lịch tưới. API key không có API điều khiển thiết bị.
- GET/api/v1/iot/alert-rules— Danh sách rule cảnh báo
- GET/api/v1/iot/alerts— Danh sách cảnh báo
- GET/api/v1/iot/commands— Danh sách lệnh thiết bị
- GET/api/v1/iot/devices— Danh sách thiết bị IoT
- GET/api/v1/iot/devices/control-states— Trạng thái điều khiển nhiều thiết bị (màn hình nhiều nhà)
- GET/api/v1/iot/devices/{deviceId}/control-state— Trạng thái điều khiển thực tế của 1 thiết bị
- GET/api/v1/iot/devices/{deviceId}/display-prefs— GET /api/v1/iot/devices/{deviceId}/display-prefs
- GET/api/v1/iot/devices/{deviceId}/fert-meters— Đồng hồ các bồn phân: chỗ cắm, hệ số bo đang dùng, và số đếm xung thô mới nhất
- GET/api/v1/iot/devices/{deviceId}/output-config/channels— Danh sách kênh ngõ ra đã cấu hình (đọc bản backend đã persist từ echo dev_cfg — không phụ thuộc realtime)
- GET/api/v1/iot/devices/{deviceId}/output-config/irrigation— Cấu hình hệ tưới đã gán: bơm/van vùng/van phân bón kể cả van Denso (đọc bản backend đã persist từ echo irr_out — không phụ thuộc realtime)
- GET/api/v1/iot/devices/{deviceId}/output-config/mcv-cfg— Trạng thái đồng bộ cài đặt van Denso: giá trị đã đặt (desired), bo đang giữ (reported, từ echo dev_cfg), ack và 1 trong 8 trạng thái
- GET/api/v1/iot/devices/{deviceId}/output-config/summary— Gói tóm tắt cấu hình ngõ ra server đã NHỚ (free_ports…) — trả JSON thô, không phụ thuộc realtime (hết chập chờn). 204 nếu server chưa từng nhận.
- GET/api/v1/iot/devices/{deviceId}/schedules— Danh sách lịch hẹn giờ của thiết bị
- GET/api/v1/iot/devices/{deviceId}/setpoints— GET /api/v1/iot/devices/{deviceId}/setpoints
- GET/api/v1/iot/devices/{id}— Chi tiết thiết bị IoT — đầy đủ fields cho 4-tab detail page
- GET/api/v1/iot/emergency-stop— Khoá dừng khẩn đang hiệu lực (activeOnly=true, mặc định) hoặc 20 lần gần nhất
- GET/api/v1/iot/reports/irrigation-logs— Danh sách lịch sử tưới (phân trang)
- GET/api/v1/iot/reports/irrigation-summary— Tổng hợp báo cáo tưới tiêu
- GET/api/v1/iot/reports/irrigation-summary/export— Xuất báo cáo tưới tiêu ra Excel
- GET/api/v1/iot/schedules/upcoming— Các cữ tưới sắp chạy của cả trại (gộp theo cữ)
- GET/api/v1/iot/search— Tìm thiết bị
- GET/api/v1/iot/sensor-readings— Tra cứu số liệu cảm biến theo khoảng thời gian
- GET/api/v1/iot/sensor-readings/latest— Giá trị mới nhất của từng thiết bị (30 phút gần nhất)
- GET/api/v1/iot/setup/progress— Tiến trình onboarding thiết bị IoT suy từ dữ liệu hiện có
/api/v1/harvestBản ghi thu hoạch, cách ly thuốc, lô truy xuất, tem QR, chứng nhận, giá thị trường.
- GET/api/v1/harvest/certifications— Danh sách chứng nhận của workspace
- GET/api/v1/harvest/certifications/expiring— Chứng nhận sắp hết hạn
- GET/api/v1/harvest/harvest-records— Danh sách bản ghi thu hoạch
- POST/api/v1/harvest/harvest-records— Khai báo thu hoạch
- GET/api/v1/harvest/harvest-records/preview-trace— Kiểm tra trước khi khoá (D2): bó truy xuất sẽ nhận những gì
- GET/api/v1/harvest/harvest-records/summary— Tổng hợp sản lượng theo hộ / vùng / cây / thửa
- GET/api/v1/harvest/harvest-records/{id}— Chi tiết bản ghi thu hoạch
- PUT/api/v1/harvest/harvest-records/{id}— Cập nhật khai báo thu hoạch
- GET/api/v1/harvest/market-prices— Danh sách giá đã ghi nhận
- GET/api/v1/harvest/market-prices/series— Chuỗi giá theo thời gian để vẽ biểu đồ
- GET/api/v1/harvest/market-prices/{id}— Chi tiết một bản ghi giá
- GET/api/v1/harvest/parcels/phi-active— Các thửa đang trong thời gian cách ly
- GET/api/v1/harvest/parcels/{parcelId}/phi-status— Thửa có đang trong thời gian cách ly không
- GET/api/v1/harvest/product-infos— Danh sách hồ sơ sản phẩm
- GET/api/v1/harvest/qr-codes— Danh sách mã QR của 1 mùa vụ
- GET/api/v1/harvest/qr-codes/usage— Số tem đã dùng / trần của gói Miễn phí (5 tem tổng / workspace)
- GET/api/v1/harvest/qr-codes/{id}/scans— Lượt quét theo ngày của một mã QR (Q6)
- GET/api/v1/harvest/search— Tìm bản ghi thu hoạch, tem QR, chứng nhận
- GET/api/v1/harvest/trace— Danh sách TraceBundle của workspace (yêu cầu đăng nhập)
- GET/api/v1/harvest/trace-anchors— Lượt neo có lô của workspace (D7) + lô đã niêm phong chờ lượt tới
- GET/api/v1/harvest/trace-certificate/{id}— Chứng thư xác thực blockchain (PDF, D4)
- GET/api/v1/harvest/trace-incidents— Sự cố lệch dữ liệu của workspace (D8)
- GET/api/v1/harvest/trace-pdf/{code}— Tải hồ sơ truy xuất PDF theo mã QR (YÊU CẦU ĐĂNG NHẬP)
- GET/api/v1/harvest/trace-seal-document/{id}— Tải văn bản niêm phong (bản đầy đủ đã băm) — chỉ người của nhà
- GET/api/v1/harvest/trace-settings— GET /api/v1/harvest/trace-settings
/api/v1/officeSổ tự dựng của trại (nhật ký, kho, chi phí…), lịch, luật tự động hoá: đọc bảng, đọc/thêm/sửa dòng.
- GET/api/v1/office/apps— Liệt kê app (phân trang)
- GET/api/v1/office/apps/{appId}/dashboards— Liệt kê bảng điều khiển của một ứng dụng
- GET/api/v1/office/apps/{appId}/tables— Liệt kê table của app
- GET/api/v1/office/apps/{appId}/tables/{tableId}— Lấy chi tiết table
- GET/api/v1/office/apps/{id}— Lấy chi tiết app
- GET/api/v1/office/automation-logs— Nhật ký chạy, mới nhất trước
- GET/api/v1/office/automation-logs/metrics— Chỉ số vận hành của Tự động hoá trong công ty
- GET/api/v1/office/automation-logs/runs— Lịch sử theo LƯỢT CHẠY, mới nhất trước
- GET/api/v1/office/automation-logs/stats— Bốn ô số liệu trên đầu màn nhật ký
- GET/api/v1/office/automation-templates— Danh sách mẫu của công ty, mới nhất trước
- GET/api/v1/office/automations— Danh sách automation
- GET/api/v1/office/automations/ai-columns/catalog— Danh mục chế độ của cột AI
- GET/api/v1/office/automations/catalog— Catalog trigger/action khả dụng để dựng automation
- GET/api/v1/office/automations/merge-fields— Danh mục biến {{…}} chèn được vào cấu hình hành động
- GET/api/v1/office/automations/quota— Hạn mức lượt chạy tháng của công ty
- GET/api/v1/office/automations/service-events— Danh mục sự kiện của phần mềm khác (kích hoạt service_event)
- GET/api/v1/office/automations/suggestions— Gợi ý tự động hoá riêng cho công ty (tab Gợi ý)
- GET/api/v1/office/automations/summary— Số đếm cho Trung tâm tự động hoá
- GET/api/v1/office/automations/{id}— Lấy 1 automation (kèm steps)
- GET/api/v1/office/automations/{id}/diagnosis— Chẩn đoán: vì sao luật chạy / không chạy
- GET/api/v1/office/automations/{id}/overlaps— Luật khác cùng kích hoạt và cùng làm việc này
- GET/api/v1/office/automations/{id}/webhook/sample— Mẫu dữ liệu + cây khoá
- GET/api/v1/office/calendar-links— Tình trạng nối lịch của tôi
- GET/api/v1/office/calendar-links/meeting-providers— Những nơi cung cấp phòng họp trực tuyến đang bật
- GET/api/v1/office/calendar-preferences— Thiết lập màn lịch của tôi
- GET/api/v1/office/calendars— Lịch tôi đang đăng ký (cột trái)
- GET/api/v1/office/calendars/subscribable— Lịch có thể đăng ký thêm
- GET/api/v1/office/connection-keys— Danh sách khoá đã cấp
- GET/api/v1/office/dashboards/{id}/widgets/{widgetId}/data— Số liệu một ô, tính theo quyền người xem
- GET/api/v1/office/events— Sự kiện trong một khoảng thời gian
- GET/api/v1/office/events/{id}— Chi tiết một sự kiện kèm người dự và phòng đã giữ
- GET/api/v1/office/events/{id}.ics— Tải tệp lịch .ics của sự kiện
- GET/api/v1/office/farm/device-controls— Danh sách phiếu lệnh
- GET/api/v1/office/farm/device-controls/emergency-stop— Trạng thái TẮT KHẨN điều khiển thiết bị tự động của trại
- GET/api/v1/office/farm/device-controls/rules/{automationId}/approval— Trạng thái duyệt tự chạy của một luật
- GET/api/v1/office/meeting-minutes— Biên bản của một cuộc họp
- GET/api/v1/office/meeting-rooms— Danh sách phòng họp
- GET/api/v1/office/meeting-rooms/{id}/busy-slots— Khung giờ bận của một phòng
- GET/api/v1/office/tables/{tableId}/fields— Liệt kê field của table
- GET/api/v1/office/tables/{tableId}/fields/{fieldId}— Lấy chi tiết field
- POST/api/v1/office/tables/{tableId}/records— Tạo record mới
- POST/api/v1/office/tables/{tableId}/records/aggregate— Cộng gộp theo cột (tổng · trung bình · nhỏ nhất · lớn nhất · đếm)
- POST/api/v1/office/tables/{tableId}/records/batch— Tạo nhiều record (tối đa 1000, all-or-nothing)
- PUT/api/v1/office/tables/{tableId}/records/batch— Cập nhật nhiều record (tối đa 1000, all-or-nothing)
- POST/api/v1/office/tables/{tableId}/records/groups— Nhóm dòng: giá trị cột nhóm + số dòng, theo đúng thứ tự của records/list
- POST/api/v1/office/tables/{tableId}/records/list— Liệt kê record (phân trang + filter có cấu trúc trong body)
- GET/api/v1/office/tables/{tableId}/records/{recordId}— Lấy chi tiết record
- PUT/api/v1/office/tables/{tableId}/records/{recordId}— Cập nhật record (merge mặc định; replace=true để ghi đè)
- GET/api/v1/office/tables/{tableId}/records/{recordId}/history— Lịch sử sửa của record, tách theo từng ô (đã lọc theo quyền cột)
- GET/api/v1/office/tables/{tableId}/trash— Thùng rác — record đã xoá mềm của bảng (phân trang)
- GET/api/v1/office/tables/{tableId}/views— Liệt kê view của table
- GET/api/v1/office/tables/{tableId}/views/{viewId}— Lấy chi tiết view
- GET/api/v1/office/tables/{tableId}/views/{viewId}/calendar-data— Record trong khoảng ngày của view kiểu Calendar
- GET/api/v1/office/tables/{tableId}/views/{viewId}/chart-data— Dữ liệu đã gộp của view kiểu Chart
- GET/api/v1/office/tasks/monitor— Màn Theo dõi: sáu ô số liệu + bảng toàn đội + việc của từng người
- GET/api/v1/office/tasks/workload— Khối lượng theo người
- GET/api/v1/office/views/{viewId}/location— Lần ngược từ mã khung nhìn lên bảng và ứng dụng chứa nó
/api/v1/reportsBáo cáo và chi phí công theo kỳ.
- GET/api/v1/reports/catalog— Danh mục báo cáo kèm số khối người xem được thấy
- GET/api/v1/reports/exports/{id}— Trạng thái một lượt xuất: pending · running · completed · failed
- GET/api/v1/reports/exports/{id}/file— Tải tệp đã xuất (404 khi quá 24 giờ)
- GET/api/v1/reports/labor-cost— Chi phí nhân công theo thửa / mùa vụ
- GET/api/v1/reports/query— Chạy báo cáo bằng GET; thiếu to = hôm nay UTC+7, thiếu from = to - 29 ngày
- GET/api/v1/reports/trace— Truy xuất ngược nhiều tầng từ một nút (phiếu thu hoạch, phiếu khoán, chứng từ, phiếu lương, phiếu bán…)