ข้ามไปเนื้อหาหลัก
ABSERPABSERP

ข้อมูลองค์กร

อ่านข้อมูลองค์กรที่คีย์สังกัด — วิธีที่เร็วที่สุดในการตรวจว่าคีย์ใช้งานได้

GET /company คืนข้อมูลองค์กรที่ API Key ผูกอยู่ ไม่ต้องส่ง id ใด ๆ เพราะตัวคีย์เป็นตัวกำหนดว่าคุณจะได้องค์กรใด

คืน ตรง ๆ ไม่ห่อด้วย data

bash
curl -X GET "$ABSERP_API_URL/openapi/v1/company" \
  -H "Authorization: Bearer $ABSERP_API_KEY"
json
{
  "id": 1,
  "name": "บริษัท เอซีเอ็มอี จำกัด",
  "workspaceKey": "acme",
  "subscriptionPlan": "free",
  "logoUrl": "https://…/logo.png",
  "timezone": "Asia/Bangkok",
  "address": {
    "formattedAddress": "…",
    "placeId": "ChIJ…",
    "latitude": 13.7563,
    "longitude": 100.5018
  },
  "countryCode": "TH",
  "currencyCode": "THB",
  "activationDate": "2026-01-01T00:00:00Z",
  "owner": "สมหญิง ใจดี",
  "isActive": true,
  "createdAt": 1735689600,
  "updatedAt": 1757289600
}
ฟิลด์หมายเหตุ
nameชื่อนิติบุคคลตามที่พิมพ์บนเอกสาร
workspaceKeyชื่อย่อขององค์กรใน URL ของ ABSERP
timezoneชื่อโซนเวลาแบบ IANA ใช้ตีความวันที่ในทุก response
currencyCodeสกุลเงินเริ่มต้นของเอกสารที่ไม่ส่ง currency
countryCodeรหัสประเทศ ISO 3166-1 alpha-2
activationDatetimestamp แบบ RFC3339 — เป็นฟิลด์เดียวใน response นี้ที่ไม่ใช่ Unix seconds
addressเป็น object ที่อาจเป็น null
isActiveองค์กรที่ปิดใช้งานจะปฏิเสธคีย์ของตัวเอง

ใช้เป็น health check

นี่คือการเรียกที่ต้องยืนยันตัวตนที่ถูกที่สุดใน API และไม่ต้องมี id จึงเหมาะกับ

  • ตรวจสอบคีย์ ทันทีหลังผู้ใช้วางคีย์ลงในหน้าตั้งค่า การได้ 200 หมายความว่าคีย์ใช้งานได้ และยังบอกว่าเป็นคีย์ของ องค์กรใด ซึ่งควรแสดงกลับให้ผู้ใช้ยืนยันว่าวางคีย์ถูกใบ
  • probe ตอนระบบเริ่มทำงาน เพื่อให้ระบบล้มเหลวทันทีเมื่อตั้งค่าผิด ไม่ใช่ไปล้มที่ request ทางธุรกิจครั้งแรก
  • อ่าน timezone และ currencyCode ครั้งเดียว แล้วนำไปใช้จัดรูปแบบข้อมูลส่วนอื่นทั้งหมด
bash
# คืนค่า exit ไม่เท่ากับศูนย์เมื่อคีย์ใช้งานไม่ได้
curl -fsS "$ABSERP_API_URL/openapi/v1/company" \
  -H "Authorization: Bearer $ABSERP_API_KEY" > /dev/null

อย่าเรียกซ้ำเป็นระยะตามตาราง เพราะจะใช้โควตาไปกับค่าที่แทบไม่เคยเปลี่ยน

ขั้นตอนถัดไป

อ่านต่อที่ ข้อมูลอ้างอิงชนิดเอกสาร