เชื่อมต่อระบบของคุณกับ Marcomm AI

1. 1
   ยื่นขอสิทธิ์เข้าถึง

   อธิบายระบบของคุณและเลือกข้อมูลที่ต้องการ เราตรวจสอบคำขอทีละรายการ

2. 2
   สร้างคีย์

   หลังได้รับอนุมัติ ให้สร้างคีย์ที่ ตั้งค่า, API คีย์จะแสดงเพียงครั้งเดียว จึงควรเก็บไว้ในระบบของคุณ

3. 3
   ส่งคำขอ

   ส่งคีย์ในส่วนหัว Authorization แล้วเรียกใช้เอนด์พอยต์ใดก็ได้ด้านล่าง

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

curl https://app.marcomm.works/api/v1/news/digest?days=7 \
  -H "Authorization: Bearer mc_live_..."

ส่งคีย์เป็นโทเค็น Bearer ในคำขอทุกครั้ง คีย์ส่วนบุคคลทำงานในนามของผู้สร้างคีย์ จึงอ่านรายการอนุมัติและตัดสินใจในนามบุคคลนั้นได้ ส่วนคีย์ของเวิร์กสเปซสร้างโดยผู้ดูแลและอ่านได้อย่างเดียว คีย์ตั้งวันหมดอายุ จำกัด IP แอดเดรส และหมุนเวียนได้ โดยคีย์เดิมจะยังใช้งานได้อีก 24 ชั่วโมงหลังการหมุนเวียน

คีย์แต่ละตัวมีเฉพาะขอบเขตที่คำขอของคุณได้รับอนุมัติ

news

สรุปข่าว บทความ และสำนักข่าว

crisis

ข่าวสำคัญและเหตุการณ์วิกฤต

approvals

รายการรออนุมัติ รวมถึงการอนุมัติหรือปฏิเสธด้วยคีย์ส่วนบุคคล

content

การอ่านข่าวประชาสัมพันธ์และบทความบล็อก

เส้นทางขึ้นต้นด้วย /api/v1 เอนด์พอยต์สำหรับอ่านใช้ GET และรับพารามิเตอร์ของคำค้น การตอบกลับเป็น JSON รูปแบบ {"data": ...}

ส่ง {"decision": "approve"} หรือ {"decision": "reject", "comment": "..."} ไปยังรายการนั้น การปฏิเสธต้องระบุความคิดเห็น การตัดสินใจใช้กฎเดียวกับในแอปและ Slack และบันทึกในชื่อเจ้าของคีย์ หากข้อความมีวลีที่ต้องยืนยัน คุณจะได้รับ 409 confirmation_required พร้อมคำเตือน และส่งคำขอซ้ำได้โดยใส่ "force": true

curl -X POST https://app.marcomm.works/api/v1/approvals/press-releases/<id> \
  -H "Authorization: Bearer mc_live_..." \
  -H "Content-Type: application/json" \
  -d '{"decision":"reject","comment":"Please fix the headline."}'

ขีดจำกัดกำหนดต่อเวิร์กสเปซ ต่อนาทีและต่อวัน (UTC) การตอบกลับมีส่วนหัวตามด้านล่างทุกครั้ง เมื่อเกินขีดจำกัดคุณจะได้รับ 429 พร้อม Retry-After หากต้องการเพิ่มขีดจำกัด ให้ขอเพิ่มได้ที่ ตั้งค่า, API ทีมงานของเราจะตรวจสอบ

X-RateLimit-Limit

จำนวนคำขอที่อนุญาตต่อนาที

X-RateLimit-Remaining

จำนวนคำขอที่เหลือในนาทีปัจจุบัน

X-RateLimit-Reset

เวลาแบบ Unix ที่หน้าต่างนาทีรีเซ็ต

X-RateLimit-Day-Limit

จำนวนคำขอที่อนุญาตต่อวัน

X-RateLimit-Day-Remaining

จำนวนคำขอที่เหลือของวันนี้

Retry-After

จำนวนวินาทีที่ต้องรอก่อนลองใหม่ ใช้เฉพาะ 429

ข้อผิดพลาดจะส่งกลับเป็น JSON รูปแบบ {"error": {"code": ..., "message": ...}}

การแจ้งเตือน คำขออนุมัติ และสรุปข่าวตอนเช้ายังส่งไปยังระบบของคุณได้ด้วย เพิ่มปลายทางที่ ตั้งค่า, API, Webhook แต่ละคำขอเป็น JSON ที่มีฟิลด์ event (alert, approval หรือ briefing), workspace, title, text, url, data และ sentAt คำขออนุมัติมี data.kind (press_release, blog หรือ event) และ data.id ซึ่งใช้อ่านและตัดสินใจผ่าน API ได้

คำขอแต่ละรายการมีลายเซ็น คำนวณ HMAC-SHA256 ของเนื้อหาคำขอดิบด้วยคีย์ลับสำหรับลายเซ็นของคุณ แล้วเทียบกับส่วนหัว X-Marcomm-Signature ซึ่งอยู่ในรูป sha256=<hex> ปฏิเสธคำขอที่ไม่ตรงกัน

การตรวจสอบ Webhook ใน Node.js

import { createHmac, timingSafeEqual } from 'node:crypto';

export function isFromMarcomm(rawBody: string, signature: string, secret: string) {
  const expected = 'sha256=' + createHmac('sha256', secret).update(rawBody).digest('hex');
  const a = Buffer.from(expected);
  const b = Buffer.from(signature);
  return a.length === b.length && timingSafeEqual(a, b);
}