ภาพรวม API สำหรับนักพัฒนา

ภาพรวม API สำหรับนักพัฒนา

REDBLU API ให้การเข้าถึงข้อมูลและการควบคุมระบบทั้งหมดผ่าน RESTful API ที่ออกแบบมาเพื่อความง่ายและประสิทธิภาพ

Base URL และการยืนยันตัวตน

Base URL

https://api.redblu.io/v1

การยืนยันตัวตน

ใช้ API Key ในรูปแบบ Bearer Token:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

การรับ API Key

1. เข้าสู่ระบบแดชบอร์ด: https://dashboard.redblu.io
2. ไปที่ Settings > API Keys
3. คลิก “Generate New Key”
4. เก็บ API Key ไว้อย่างปลอดภัย

ผลิตภัณฑ์ที่รองรับ

SiloScale API

• การตรวจสอบระดับวัตถุดิบ
• ควบคุมการป้อนและปล่อย
• ข้อมูลเซ็นเซอร์เรียลไทม์

AutoScraper API

• ควบคุมการเก็บเกี่ยว
• วิเคราะห์ผลผลิต
• จัดการแผนการทำงาน

TeleScraper API

• ควบคุมระยะไกล
• ข้อมูล IoT และเซ็นเซอร์
• การวิเคราะห์ข้อมูล

AutoScale API

• ข้อมูลการชั่งน้ำหนัก
• ควบคุมระบบบรรจุ
• รายงานคุณภาพ

Response Format

ทุก API จะตอบกลับในรูปแบบ JSON:

{
  "success": true,
  "data": {
    "message": "Operation completed successfully"
  },
  "timestamp": "2024-08-05T12:00:00Z",
  "request_id": "req_abc123"
}

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid parameter: device_id is required",
    "details": {}
  },
  "timestamp": "2024-08-05T12:00:00Z",
  "request_id": "req_def456"
}

HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
429	Rate Limited
500	Internal Server Error

Rate Limiting

• Free Tier: 1,000 requests/hour
• Pro Tier: 10,000 requests/hour
• Enterprise: Unlimited

Rate limit headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1691236800

SDKs และ Libraries

JavaScript/Node.js

npm install @redblu/api-client

import { RedBluClient } from '@redblu/api-client';

const client = new RedBluClient({
  apiKey: 'your-api-key',
  baseURL: 'https://api.redblu.io/v1'
});

Python

pip install redblu-python

from redblu import RedBluClient

client = RedBluClient(api_key='your-api-key')

PHP

composer require redblu/php-client

use RedBlu\Client;

$client = new Client([
    'api_key' => 'your-api-key'
]);

Webhooks

รับการแจ้งเตือนเมื่อมีเหตุการณ์สำคัญ:

POST https://your-domain.com/webhook
Content-Type: application/json
X-RedBlu-Signature: sha256=...

{
  "event": "device.alert",
  "device_id": "silo_001",
  "timestamp": "2024-08-05T12:00:00Z",
  "data": {
    "alert_type": "low_level",
    "current_level": 15,
    "threshold": 20
  }
}

การทดสอบ API

ใช้ cURL

curl -X GET \
  https://api.redblu.io/v1/devices \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json'

ใช้ Postman

1. Import Collection: https://api.redblu.io/postman/collection.json
2. ตั้งค่า Environment Variable: api_key
3. เริ่มทดสอบ API endpoints

ใช้ Insomnia

1. Import Workspace: https://api.redblu.io/insomnia/workspace.json
2. ตั้งค่า Base Environment
3. เริ่มใช้งาน

ตัวอย่างการใช้งาน

ตรวจสอบสถานะอุปกรณ์

// Get all devices
const devices = await client.devices.list();

// Get specific device
const device = await client.devices.get('silo_001');

// Get device status
const status = await client.devices.getStatus('silo_001');

ควบคุมอุปกรณ์

// Start operation
await client.devices.start('silo_001', {
  operation: 'feed',
  amount: 100,
  rate: 10
});

// Stop operation
await client.devices.stop('silo_001');

รับข้อมูลเซ็นเซอร์

// Real-time data
const data = await client.sensors.getRealtime('silo_001');

// Historical data
const history = await client.sensors.getHistory('silo_001', {
  from: '2024-08-01T00:00:00Z',
  to: '2024-08-05T23:59:59Z',
  interval: '1h'
});

สำหรับรายละเอียด API แต่ละผลิตภัณฑ์ กรุณาดูหัวข้อถัดไป