API¶

API ของ Gem Logic ช่วยให้คุณเชื่อมต่อกับระบบภายนอกและทำงานอัตโนมัติได้ คุณสามารถใช้เพื่อจัดการสินค้า การขาย ผู้ติดต่อ การซ่อม การนับสินค้าคงคลัง และงานพิมพ์ผ่านโปรแกรมได้

ไปที่ การตั้งค่า ‣ API เพื่อสร้างและจัดการคีย์ API ของคุณ

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

คำขอ API ทั้งหมดต้องมีคีย์ API ใน HTTP header x-api-key คุณสามารถสร้างคีย์ได้จากหน้า การตั้งค่า ‣ API คีย์สามารถปิดใช้งานหรือลบได้ตลอดเวลา

ตัวอย่างคำขอ:

curl -X GET https://your-instance.gem-logic.com/api/marketplaces/ \
  -H "x-api-key: YOUR_API_KEY"

Danger

เก็บคีย์ API ของคุณเป็นความลับ อย่าแชร์ในที่เก็บข้อมูลสาธารณะหรือโค้ดฝั่งไคลเอนต์ หากคีย์ถูกบุกรุก ให้ปิดใช้งานทันทีและสร้างคีย์ใหม่

URL ฐาน¶

endpoints ทั้งหมดเป็นเส้นทางสัมพันธ์กับ URL ของอินสแตนซ์ของคุณ ภายใต้คำนำหน้า /api/:

https://your-instance.gem-logic.com/api/

รูปแบบการตอบกลับ¶

การตอบกลับทั้งหมดส่งคืนเป็น JSON คำขอที่สำเร็จจะส่งคืนรหัสสถานะ 200 (สำหรับ GET) หรือ 201 (สำหรับ POST) ข้อผิดพลาดจะส่งคืนรหัสสถานะที่เหมาะสมพร้อมข้อความ:

200 OK — คำขอ GET สำเร็จ
201 Created — คำขอ POST สำเร็จ
400 Bad Request — ข้อมูลไม่ถูกต้องหรือขาดหายไป
401 Unauthorized — คีย์ API ไม่ถูกต้องหรือขาดหายไป
404 Not Found — ไม่พบทรัพยากร

Endpoints¶

ช่องทางการขาย¶

เมธอด	`GET`
URL	`/api/marketplaces/`
คำอธิบาย	ส่งคืนรายการช่องทางการขายทั้งหมด

ฟิลด์ในการตอบกลับ:

ฟิลด์	Type	คำอธิบาย
`id`	integer	ตัวระบุเฉพาะ
`marketplace`	string	ชื่อ marketplace

สินค้า¶

รายการสินค้า

เมธอด	`GET`
URL	`/api/products/{marketplace_id}`
คำอธิบาย	ส่งกลับรายการสินค้าที่กรองตาม marketplace โดยใช้ marketplace ID จาก endpoint ของ marketplaces

ฟิลด์ในการตอบกลับ:

ฟิลด์	Type	คำอธิบาย
`id`	integer	ตัวระบุเฉพาะ
`item_sku`	string	SKU ของสินค้า
`created`	datetime	วันที่สร้าง
`status`	string	สถานะสินค้า
`images`	array	รายการภาพสินค้า (`id`, `image`)
`item_weight`	decimal	น้ำหนัก
`item_height`	decimal	ความสูง
`item_length`	decimal	ความยาว
`item_width`	decimal	ความกว้าง

สร้างภาพสินค้า

เมธอด	`POST`
URL	`/api/products/create/image/`
คำอธิบาย	อัปโหลดภาพสินค้าโดยใช้การเข้ารหัส base64 หาก SKU ของสินค้ายังไม่มีอยู่ ระบบจะสร้างสินค้าใหม่โดยอัตโนมัติ

ฟิลด์คำขอ:

ฟิลด์	Type	จำเป็นต้องระบุ	คำอธิบาย
`item_sku`	string	ใช่	SKU ของสินค้าที่ต้องการแนบภาพ
`image`	string (base64)	ใช่	ข้อมูลภาพที่เข้ารหัสด้วย base64

การขาย¶

แสดงรายการการขาย

เมธอด	`GET`
URL	`/api/sales/`
คำอธิบาย	ส่งคืนรายการคำสั่งขายทั้งหมด

ฟิลด์ในการตอบกลับ:

ฟิลด์	Type	คำอธิบาย
`order_id`	string	รหัสคำสั่งซื้อที่ไม่ซ้ำกัน

สร้างการขาย

เมธอด	`POST`
URL	`/api/sales/create/`
คำอธิบาย	สร้างคำสั่งขายใหม่

ผู้ติดต่อ¶

เมธอด	`GET`
URL	`/api/contacts/`
คำอธิบาย	ส่งคืนรายการผู้ติดต่อทั้งหมด

ฟิลด์ในการตอบกลับ:

ฟิลด์	Type	คำอธิบาย
`id`	integer	ตัวระบุเฉพาะ
`complete_name`	string	ชื่อเต็ม
`contact_type`	string	ประเภทของผู้ติดต่อ
`email`	string	ที่อยู่อีเมล
`phone`	string	หมายเลขโทรศัพท์
`language`	string	ภาษาที่ต้องการ

การซ่อม¶

สร้างการซ่อม

เมธอด	`POST`
URL	`/api/repairs/create/`
คำอธิบาย	สร้างคำสั่งซ่อมใหม่พร้อมรายการซ่อมที่เชื่อมโยง หากไม่ได้ระบุช่องทางการขายหรือแผนก จะใช้ช่องแรกที่มีอยู่

ฟิลด์คำขอ:

ฟิลด์	Type	จำเป็นต้องระบุ	คำอธิบาย
`client_id`	integer	ไม่จำเป็น	ID ของลูกค้า/ผู้ติดต่อ
`marketplace`	string / integer	ไม่จำเป็น	ID หรือชื่อช่องทางการขาย
`division_id`	integer	ไม่จำเป็น	ID ของแผนกธุรกิจ
`title`	string	ไม่จำเป็น	ชื่อหรือคำอธิบายของรายการซ่อม
`repair_info_1`	string	ไม่จำเป็น	ความคิดเห็นเพิ่มเติมเกี่ยวกับการซ่อม
`repair_info_2`	string	ไม่จำเป็น	ความคิดเห็นเพิ่มเติมเกี่ยวกับการซ่อม
`repair_info_3`	string	ไม่จำเป็น	ความคิดเห็นเพิ่มเติมเกี่ยวกับการซ่อม
`quantity`	decimal	ไม่จำเป็น	ปริมาณ (ค่าเริ่มต้น: 1)
`weight`	decimal	ไม่จำเป็น	น้ำหนักของรายการ
`weight_unit`	string	ไม่จำเป็น	หน่วยวัดน้ำหนัก
`size`	string	ไม่จำเป็น	ขนาดของรายการ
`color`	string	ไม่จำเป็น	สีของรายการ
`engravement`	string	ไม่จำเป็น	ข้อความสลัก
`client_reference` \| string		ไม่จำเป็น	หมายเลขอ้างอิงของลูกค้า

ตัวอย่างผลลัพธ์:

{"message": "Repair created successfully.", "order_id": "R-0001"}

เพิ่มรายการในการซ่อม

เมธอด	`POST`
URL	`/api/repairs/add-item/`
คำอธิบาย	เพิ่มรายการใหม่ในคำสั่งซ่อมที่มีอยู่

ฟิลด์คำขอ:

ฟิลด์	Type	จำเป็นต้องระบุ	คำอธิบาย
`order_id`	string	ใช่	ID คำสั่งซ่อมที่จะเพิ่มรายการ
`item_sku`	string	ไม่จำเป็น	SKU ของสินค้าที่จะเชื่อมโยงกับรายการ
`title`	string	ไม่จำเป็น	ชื่อเรื่องหรือคำอธิบาย
`repair_info_1`	string	ไม่จำเป็น	ความคิดเห็นเพิ่มเติมเกี่ยวกับการซ่อม
`repair_info_2`	string	ไม่จำเป็น	ความคิดเห็นเพิ่มเติมเกี่ยวกับการซ่อม
`repair_info_3`	string	ไม่จำเป็น	ความคิดเห็นเพิ่มเติมเกี่ยวกับการซ่อม
`quantity`	decimal	ไม่จำเป็น	ปริมาณ (ค่าเริ่มต้น: 1)
`weight`	decimal	ไม่จำเป็น	น้ำหนักของรายการ
`weight_unit`	string	ไม่จำเป็น	หน่วยวัดน้ำหนัก
`size`	string	ไม่จำเป็น	ขนาดของรายการ
`color`	string	ไม่จำเป็น	สีของรายการ
`engravement`	string	ไม่จำเป็น	ข้อความสลัก
`client_reference` \| string		ไม่จำเป็น	หมายเลขอ้างอิงของลูกค้า
`cost`	decimal	ไม่จำเป็น	ต้นทุนของรายการ

การตรวจนับสินค้าคงคลัง¶

สร้างการตรวจนับสินค้าคงคลัง

เมธอด	`POST`
URL	`/api/inventory-counts/`
คำอธิบาย	สร้างเซสชันการตรวจนับสินค้าคงคลังใหม่

ฟิลด์ในการตอบกลับ:

ฟิลด์	Type	คำอธิบาย
`id`	string	ID การตรวจนับสินค้าคงคลัง
`created_at`	datetime	เวลาที่สร้าง
`status`	string	เป็น `active` เสมอ
`tag_count`	integer	จำนวนสินค้าที่ตรวจนับ

แสดงรายการสินค้าที่ตรวจนับ

เมธอด	`GET`
URL	`/api/inventory-counts/{inventory_count_id}/products/`
คำอธิบาย	แสดงสินค้าทั้งหมดที่ตรวจนับในการตรวจนับสินค้าคงคลังที่ระบุ

ฟิลด์ในการตอบกลับ:

ฟิลด์	Type	คำอธิบาย
`id`	string	ตัวระบุเฉพาะ
`created_at`	datetime	เวลาที่ตรวจนับสินค้า
`product_sku`	string	SKU ของสินค้า
`product_name`	string	ชื่อสินค้า
`quantity`	integer	ปริมาณที่นับได้

งานพิมพ์¶

เมธอด	`POST`
URL	`/api/print-pdf/`
คำอธิบาย	อัปโหลดไฟล์ PDF ไปยังคิวพิมพ์สำหรับเครื่องพิมพ์ที่ระบุ ไฟล์จะได้รับการตรวจสอบความถูกต้องของรูปแบบและความปลอดภัย ขนาดไฟล์สูงสุด 20 MB โปรดใช้ประเภทเนื้อหา `multipart/form-data`

ฟิลด์คำขอ:

ฟิลด์	Type	จำเป็นต้องระบุ	คำอธิบาย
`pdf`	ไฟล์	ใช่	ไฟล์ PDF ที่จะพิมพ์ (สูงสุด 20 MB)
`printer_uuid`	UUID	ใช่	UUID ของเครื่องพิมพ์เป้าหมาย
`landscape`	บูลีน	ไม่จำเป็น	พิมพ์ในโหมดแนวนอน (ค่าเริ่มต้น: false)

ตัวอย่างคำขอ:

curl -X POST https://your-instance.gem-logic.com/api/print-pdf/ \
  -H "x-api-key: YOUR_API_KEY" \
  -F "pdf=@document.pdf" \
  -F "printer_uuid=YOUR_PRINTER_UUID"

ตัวอย่างผลลัพธ์:

{"status": "queued", "print_job_id": 42}

เครื่องมือสำรวจ API แบบโต้ตอบ¶

Gem Logic มาพร้อมกับเครื่องมือสำรวจ API แบบโต้ตอบที่ขับเคลื่อนด้วย Swagger UI คุณสามารถเข้าถึงได้จากลิงก์ เอกสาร API ในหน้า การตั้งค่า ‣ API เครื่องมือสำรวจช่วยให้คุณทดลองใช้แต่ละ endpoint ได้โดยตรงจากเบราว์เซอร์ของคุณ