Tài liệu
Mọi lời gọi đi qua gateway bằng khoá API của trang trại.
| Môi trường | Địa chỉ gốc |
|---|---|
| Production | https://api-prod.nextfarm.vn |
| Sandbox | https://api-dev.nextfarm.vn |
Bắt đầu nhanh
Tạo khoá và gọi API đầu tiên trong 3 bước.
Khoá API và phạm vi
Header, 22 phạm vi, giới hạn an toàn, mã lỗi.
Webhook
3 sự kiện, tin mẫu, kiểm chữ ký, lịch thử lại.
MCP cho trợ lý AI
Nối Claude/ChatGPT, 15 công cụ.
Bảo mật
Chứng từ, phạm vi tối thiểu, chữ ký HMAC-SHA256, HTTPS, xoay khoá, báo lỗ hổng.
OAuth cho ứng dụng
Làm phần mềm cho nhiều trại: đăng ký, trại cho phép, client_credentials.
Tham chiếu API — 18 thao tác
Bản đồ & mùa vụ →
/api/v1/gisThửa đất, vùng, nông dân, mùa vụ — nền dữ liệu không gian của trang trại.
- GET/api/v1/gis/parcels— Danh sách thửa: mã, diện tích, vùng, cây đang trồng.
- GET/api/v1/gis/parcels/{id}— Chi tiết một thửa: ranh giới, diện tích, chủ, mùa vụ.
- GET/api/v1/gis/seasons— Mùa vụ theo năm: cây, thửa, ngày trồng, dự kiến thu hoạch.
- GET/api/v1/gis/search— Tìm thửa, mùa vụ, nông dân, vùng (phần nào thiếu phạm vi thì rỗng).
IoT (chỉ đọc) →
/api/v1/iotThiết bị, số đo cảm biến, cảnh báo. Không có API điều khiển thiết bị cho khoá API.
- GET/api/v1/iot/devices— Thiết bị và trạng thái kết nối (is_online).
- GET/api/v1/iot/sensor-readings/latest— Số đo mới nhất của cả trại hoặc một vùng.
- GET/api/v1/iot/sensor-readings— Lịch sử số đo theo thiết bị/vùng và khoảng thời gian.
- GET/api/v1/iot/alerts— Cảnh báo cảm biến vượt ngưỡng.
- GET/api/v1/iot/search— Tìm thiết bị theo tên, mã.
Thu hoạch & truy xuất →
/api/v1/farm-harvestBản ghi thu hoạch, lô truy xuất nguồn gốc, tem QR, chứng nhận VietGAP/GlobalGAP.
- GET/api/v1/farm-harvest/harvest-records— Bản ghi thu hoạch: thửa, cây, sản lượng (kg), trạng thái.
- POST/api/v1/farm-harvest/harvest-records— GHI: khai báo một lô thu hoạch (confirm=true thì xác nhận ngay và phát sự kiện harvest.batch.created).
- GET/api/v1/farm-harvest/trace— Lô truy xuất đã phát hành.
- GET/api/v1/farm-harvest/trace/{id}— Chi tiết lô: nhật ký canh tác, chứng nhận, ảnh.
- GET/api/v1/farm-harvest/certifications/expiring— Chứng nhận sắp hết hạn.
- GET/api/v1/farm-harvest/search— Tìm lô, tem QR, chứng nhận.
Sổ nông trại →
/api/v1/officeSổ tự dựng của trại (nhật ký, kho, chi phí…): đọc bảng, đọc dòng, thêm dòng.
- GET/api/v1/office/apps/{app_id}/tables— Các bảng trong một sổ và cấu trúc cột.
- POST/api/v1/office/tables/{table_id}/records/list— Đọc dòng của một bảng (POST vì thân chứa bộ lọc).
- POST/api/v1/office/tables/{table_id}/records— GHI: thêm một dòng. data = {id_cột: giá_trị}.