OGORI Carbon Credit Calculator

Tính toán Hướng dẫn Đăng nhập

Tài liệu API Carbon Credit Calculator

Xác thực

Mọi request đến API cần gửi kèm API key trong header:

X-API-KEY: your_api_key_here
API key có thể được cấu hình trong trang Quản trị > Cấu hình hệ thống

Endpoints

POST /api.php

Tính toán carbon credits cho một khu vực canh tác.

Request Parameters
{
    // Thông tin cơ bản (bắt buộc)
    "crop_type": "string",    // Tên loại cây trồng
    "tree_age": number,       // Tuổi cây
    "age_unit": "years|months", // Đơn vị tuổi

    // Diện tích và mật độ (một trong hai cách)
    "tree_count": number,     // Số lượng cây (ưu tiên nếu có)
    "area": number,           // Diện tích (ha)
    "row_spacing": number,    // Khoảng cách hàng (m)
    "plant_spacing": number,  // Khoảng cách cây (m)

    // Phân bón (tùy chọn)
    "fertilizer_type": string[],    // Mảng tên các loại phân bón
    "fertilizer_amount": number[],  // Mảng khối lượng tương ứng (kg)
    "other_fertilizer_ghg": number, // Phát thải khác từ phân bón (kg CO2e)

    // Thuốc BVTV (tùy chọn)
    "pesticide_type": string[],    // Mảng tên các loại thuốc
    "pesticide_amount": number[],  // Mảng khối lượng tương ứng (kg/L)
    "other_pesticide_ghg": number, // Phát thải khác từ thuốc BVTV (kg CO2e)

    // Năng lượng (tùy chọn)
    "energy_use": string[],       // Mảng ID mục đích sử dụng
    "energy_source": string[],    // Mảng ID nguồn năng lượng
    "energy_consumption": number[], // Mảng lượng tiêu thụ

    // Sinh khối (tùy chọn)
    "biomass_method": string[],   // Mảng ID phương pháp xử lý
    "biomass_amount": number[]    // Mảng khối lượng (tấn)
}
Response
{
    "status": "success|error",
    "results": {
        "carbon_absorbed_co2e": number,     // tCO2e/năm
        "total_emissions": number,          // tCO2e/năm
        "carbon_credits": number,           // tCO2e/năm
        "emissions_breakdown": {
            "fertilizers": number,          // tCO2e/năm
            "pesticides": number,           // tCO2e/năm
            "energy": number,               // tCO2e/năm
            "biomass": number               // tCO2e/năm
        },
        "details": {
            "absorption": {
                "method": "tree_count|spacing_density|standard_area",
                "rate": number,             // tCO2e/ha/năm
                "standard_density": number,  // cây/ha
                "absorption_per_tree": number, // tCO2e/cây/năm
                "actual_density": number,    // cây/ha thực tế
                "notes": string             // Ghi chú về phương pháp
            },
            "fertilizers": [{
                "type": string,
                "amount": number,
                "emission_factor": number,
                "emission_kg": number
            }],
            "pesticides": [{
                "type": string,
                "amount": number,
                "emission_factor": number,
                "emission_kg": number
            }],
            "energy": [{
                "use": string,
                "source": string,
                "consumption": number,
                "unit": string,
                "emission_factor": number,
                "emission_kg": number
            }],
            "biomass": [{
                "method": string,
                "amount": number,
                "ch4_kg_per_tonne": number,
                "n2o_kg_per_tonne": number,
                "emission_tco2e": number
            }]
        },
        "projection_data": {
            "years": string[],              // Mảng năm dự báo
            "values": number[]              // Mảng giá trị dự báo tCO2e
        },
        "warnings": string[]                // Cảnh báo nếu có
    },
    "message": string                       // Chi tiết lỗi nếu có
}
Error Codes
  • 400 - Dữ liệu đầu vào không hợp lệ
  • 401 - API key không hợp lệ
  • 429 - Vượt quá giới hạn request
  • 500 - Lỗi server
Example Request
curl -X POST 'https://your-domain.com/api.php' \
    -H 'Content-Type: application/json' \
    -H 'X-API-KEY: your_api_key_here' \
    -d '{
    "crop_type": "Cao su",
    "tree_age": 5,
    "age_unit": "years",
    "area": 10,
    "row_spacing": 2.5,
    "plant_spacing": 6,
    "fertilizer_type": ["NPK 16-16-8"],
    "fertilizer_amount": [100],
    "energy_use": ["bom_tuoi"],
    "energy_source": ["dien_luoi"],
    "energy_consumption": [500],
    "biomass_method": ["ủ_phân_hữu_cơ"],
    "biomass_amount": [2]
}'

Giới hạn Request

API có giới hạn số lượng request trong một khoảng thời gian:

  • Tối đa 100 requests trong 60 phút
  • Khi vượt giới hạn, API sẽ trả về status code 429
  • Header Retry-After sẽ cho biết thời gian cần đợi (giây)

Lưu ý

  • Tất cả giá trị phát thải và hấp thụ được tính theo tCO2e/năm
  • Với cây trồng mới, cần sử dụng tree_count hoặc area + row_spacing + plant_spacing để tính chính xác
  • Nếu cung cấp cả tree_count và area, hệ thống sẽ ưu tiên dùng tree_count
  • Dữ liệu trong mảng fertilizer_type và fertilizer_amount phải có cùng độ dài
  • Tương tự cho pesticide_type/amount, energy_use/source/consumption, biomass_method/amount

Công cụ kiểm thử API

Để kiểm thử API trực tiếp, bạn có thể sử dụng:

  • Trang kiểm thử API
  • Form tính toán trên trang chủ sẽ hiển thị request API tương ứng
OGORI

CTính toán Carbon Credit trong nông nghiệp

Liên kết
  • Trang chủ
  • Hướng dẫn sử dụng
  • Tài liệu API
Thông tin
  • Version: 1.0.0

Copyright © 2024 OGORI Carbon Credit Calculator. All rights reserved.