REST API

ทุกการทำงานในหน้าจอ Celerp คือ REST endpoint ตัวเดียวกับที่ UI เรียกใช้ภายใน คุณจึงนำไปทำงานอัตโนมัติ เชื่อมกับระบบอื่น หรือสร้างเครื่องมือของคุณเองได้ API ทำงานในเครื่องบนข้อมูลของคุณ ไม่มีอะไรถูกส่งขึ้นคลาวด์

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

Celerp ใช้ JSON Web Tokens ที่มีอายุสั้น เข้าสู่ระบบด้วยอีเมลและรหัสผ่าน Celerp เพื่อรับ access token จากนั้นส่งเป็น Bearer header ในทุกคำขอ

1. เข้าสู่ระบบ

curl -X POST http://localhost:8000/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "password": "your-password"}'

การตอบกลับมีสอง token:

{
  "access_token": "eyJhbGciOiJI...",
  "refresh_token": "eyJhbGciOiJI..."
}

2. เรียก API ด้วย token

curl http://localhost:8000/items \
  -H "Authorization: Bearer eyJhbGciOiJI..."

• Token ระบุผู้ใช้ บทบาท และบริษัท คำขอจึงถูกจำกัดขอบเขตไปยังบริษัทนั้นโดยอัตโนมัติ ไม่ต้องใช้ header เพิ่มเติม
• Access token มีอายุสูงสุด 24 ชั่วโมง เมื่อหมดอายุ รับคู่ใหม่โดย POST refresh_token ไปที่ /auth/token/refresh
• อยู่หลายบริษัทใช่ไหม ดูรายชื่อด้วย GET /auth/my-companies แล้วขอ token สำหรับอีกบริษัทด้วย POST /auth/switch-company/{company_id}

การส่งคำขอ

ทุก endpoint อยู่ใต้ที่อยู่ของ API server ของคุณ (http://localhost:8000 สำหรับการติดตั้งด้วย pip ตามตัวอย่างด้านล่าง) และคืนค่าเป็น JSON โดย endpoint แบบรายการจะคืนอาร์เรย์ items พร้อมจำนวนรวม total:

curl "http://localhost:8000/items?limit=20&offset=0" \
  -H "Authorization: Bearer $TOKEN"

{
  "items": [
    { "id": "item:...", "sku": "WIDGET-001", "name": "Widget", "quantity": 42 }
  ],
  "total": 142
}

Pagination: ส่ง ?limit= (ค่าเริ่มต้น 50) และ ?offset= endpoint แบบรายการส่วนใหญ่ยังรับคำค้น q= และตัวกรองรายคอลัมน์ได้ด้วย (เช่น ?status=available)

การสร้างข้อมูล

POST JSON เพื่อสร้างระเบียน การเขียนคืนค่า id ของ entity ใหม่ (และ event_id ที่อยู่เบื้องหลัง ทุกการเปลี่ยนแปลงใน Celerp คือ event)

curl -X POST http://localhost:8000/crm/contacts \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corp",
    "email": "[email protected]",
    "contact_type": "customer",
    "idempotency_key": "acme-2026-06-21"
  }'

ข้อตกลง

• ข้อผิดพลาด การตอบกลับที่ไม่ใช่ 2xx คืนค่า {"detail": "..."} พร้อม HTTP status code มาตรฐาน
• Rate limit 60 คำขอ/นาทีต่อ IP โดยค่าเริ่มต้น การเข้าสู่ระบบจำกัดที่ 10/นาที การเกินขีดจำกัดคืนค่า 429
• สิทธิ์ แต่ละ endpoint ถูกจำกัดตามบทบาทของคุณ: viewer → operator → manager → admin → owner
• ขอบเขตบริษัท ทุกคำขอดำเนินการกับบริษัทใน token ของคุณ สลับบริษัทเพื่อดำเนินการกับบริษัทอื่น

Endpoints ทั่วไป

นี่เป็นเพียงส่วนเล็ก ๆ ไว้ให้เริ่มต้น แต่ละโมดูลจะเพิ่ม endpoint ของตัวเองเข้ามา ดูรายการทั้งหมดได้จาก OpenAPI schema ด้านล่าง

เอกสารอ้างอิงฉบับเต็มแยกตามหมวด

endpoint ทั้งหมดที่ API ให้บริการ แบ่งตามหมวด แต่ละหน้าระบุเมธอด พาธ พารามิเตอร์ รูปแบบคำขอและคำตอบ และตัวอย่างการเรียกใช้

สำรวจ API ทั้งหมด

เอกสารอ้างอิงฉบับสมบูรณ์ที่อัปเดตอยู่เสมอ คือ OpenAPI 3.1 schema ที่ instance ของคุณสร้างขึ้นเอง:

GET http://localhost:8000/openapi.json

โหลดเข้าเครื่องมือ OpenAPI ตัวไหนก็ได้ ไม่ว่าจะเป็น Postman, Insomnia, Swagger UI หรือตัวสร้าง client เพื่อไล่ดูทุก endpoint และ model ทดลองยิงคำขอ และสร้าง typed client ในภาษาที่คุณใช้ Celerp ให้ตัว schema มาตรง ๆ แทนที่จะทำหน้าเอกสารออนไลน์ หน้าตา API ของคุณจึงอยู่กับ instance ของคุณเท่านั้น