API ของ WebsiteCoach
ใช้ API ของ WebsiteCoach เพื่อดึงรายงานเว็บไซต์ที่แคชไว้และรายการงานที่จัดลำดับความสำคัญสำหรับแดชบอร์ด พอร์ทัลลูกค้า และระบบอัตโนมัติ
Ludwig Makhyan · ผู้ก่อตั้ง, WebsiteCoach
ข้ามไปที่ส่วน
API ของ WebsiteCoach ใช้ทำอะไร
API ของ WebsiteCoach ให้ผู้ใช้ที่ลงทะเบียนเข้าถึงข้อมูลรายงานเดียวกับที่ดูในแอปผ่านโปรแกรม เหมาะสำหรับแดชบอร์ดภายใน พอร์ทัลลูกค้า เวิร์กโฟลว์รายงาน และเครื่องมืออัตโนมัติที่ต้องการข้อมูลสุขภาพเว็บไซต์ในรูปแบบ JSON
เอกสารสาธารณะตั้งใจไม่เปิดเผยโทเคนส่วนตัว รายละเอียดภายใน route สำหรับแอดมินเท่านั้น หรือการตั้งค่าการ crawl ที่ละเอียดอ่อน ผู้ใช้สร้างและจัดการโทเคน API ของตนเองจากพื้นที่โปรไฟล์หลังเข้า สู่ระบบ
รายงาน JSON ที่แคชไว้
ดึงรายงานล่าสุดที่บันทึกไว้สำหรับโดเมน พร้อมคะแนน เมตริก แผนก และหลักฐาน
เอนด์พอยต์รายการงาน
ดึงเฉพาะรายการแก้ไขที่จัดลำดับความสำคัญ พร้อมระดับความสำคัญ แผนก คำอธิบาย เมตริก เป้าหมาย และความมั่ นใจ
พรอมป์แก้ไขด้วย AI
ดึงพรอมป์ที่คัดลอกไปใช้กับเครื่องมือเขียนโค้ด AI ได้ทันที พร้อมหลักฐานการ audit, URL, ลิงก์เรียนรู้ และคำแนะนำแบบ manual สำหรับการแก้ไขฝั่งผู้ให้บริการ
การเข้าถึงที่ผูกกับประวัติ
การดูรายงานผ่าน API จะผูกกับผ ู้ใช้ที่ยืนยันตัวตน เพื่อให้โดเมนเดียวกันปรากฏในประวัติบัญชีและแอดมิน
การควบคุมโทเคน
ผู้ใช้สามารถสร้างโทเคนแยกสำหรับเครื่องมือต่าง ๆ และยกเลิกโทเคนโดยไม่เปิดเผยรหัสผ่านหรือเซสชัน
เอนด์พอยต์ API สาธารณะ
รายงานแคชแบบเต็ม
ใช้เมื่อแอปของคุณต้องการรายงานที่บันทึกไว้ทั้งหมดสำหรับโดเมน
GET https://websitecoach.com/api/reports?url=example.com&token=YOUR_TOKEN&lang=enเฉพาะรายการงาน
ใช้สำหรับสร้าง ticket แดชบอร์ดผู้บริหาร หรือ integration ที่ต้องการเฉพาะรายการแก้ไขที่จัดลำดับไว้
GET https://websitecoach.com/api/actionitems?url=example.com&token=YOUR_TOKEN&lang=enPayload แก้ไขด้วย AI
ใช้เมื่อ workflow ของคุณส่งผลตรวจจาก WebsiteCoach ไปยัง ChatGPT, Claude, Gemini, Cursor หรือผู้ช่วยเขียนโค้ด AI อื่น
GET https://websitecoach.com/api/payload?url=example.com&token=YOUR_TOKENResponse จะส่งคืน action item ทุกข้อพร้อมแผนก ระดับความสำคัญ ลิงก์เรียนรู้ หลักฐาน audit และพรอมป์แบบมีโครงสร้าง พรอมป์จะสั่งให้ AI ตรวจสอบ stack ของผู้ใช้ก่อน และเมื่อการแก้ไขอยู่ใน DNS, CDN, email, registrar, CMS หรือ console ภายนอกอื่น ให้ให้ runbook แบบ manual อย่างละเอียดแทนการเดาการแก้ไขโค้ด
รูปแบบ Bearer token
แอปฝั่งเซิร์ฟเวอร์สามารถส่งโทเคนใน header Authorization แทน query string ได้
Authorization: Bearer YOUR_TOKENความปลอดภัยของโทเคนและข้อมูล
เก็บโทเคนไว้ฝั่งเซิร์ฟเวอร์
- อย่าใส่โทเคน API ใน JavaScript สาธารณะ แอปมือถือ ภาพหน้าจอ หรือเอกสารที่แชร์
- สร้างโทเคนแยกสำหรับแต่ละแอป เพื่อให้ยกเลิก integration หนึ่งได้โดยไม่กระทบอย่างอื่น
- ใช้ HTTPS เท่านั้น และหมุนเวียนโทเคนเมื่อเพื่อนร่วมทีม ผู้ให้บริการ หรือระ บบไม่ต้องการเข้าถึงอีกต่อไป
- API ส่งคืนเฉพาะข้อมูลรายงานที่เจ้าของโทเคนที่ยืนยันตัวตนเข้าถึงได้ ไม่เปิดเผยรหัสผ่าน เซสชัน ความลับการชำระเงิน route แอดมิน หรือ header crawl ส่วนตัว
การเข้าถึงและข้อจำกัด
การเข้าถึง API มีให้สำหรับผู้ใช้ที่ลงทะเบียนแล้ว ผู้ใช้แต่ละคนสามารถสร้างโทเคน API ที่ใช้งานได้สูงสุด 10 รายการจากโปรไฟล์
การเรียก API ออกแบบมาสำหรับดึงรายงานที่แคชไว้และเวิร์กโฟลว์รายการงาน การสแกนใหม่และการรีเฟรชด้วยเครดิตอาจเปลี่ยนแปลงได้ ดังนั้น integration สาธารณะควรใช้เอนด์พอยต์รายงานแคชและรายการงานที่เอกสารระบุไว้
หากต้องการสร้างหรือยกเลิกโทเคน ให้เข้าสู่ระบบและเปิด API tokens.
ต้องการ integration ส่วนตัวหรือไม่?
สำหรับกรณีพันธมิตรหรือองค์กร โปรดติดต่อ WebsiteCoach ก่อนสร้างบนพฤติกรรมที่ไม่ใช่สาธารณะ เอกสารสาธารณะคือสัญญาที่เสถียร
หัวข้อที่เกี่ยวข้อง