Get Tools Lab API
ผสานรวมเครื่องมือ คำแนะนำ และเวิร์กโฟลว์แพลตฟอร์มที่เผยแพร่โดยใช้จุดสิ้นสุดของนักพัฒนาที่ได้รับการตรวจสอบสิทธิ์ ความสามารถที่มีจะขึ้นอยู่กับโมดูล API ที่เปิดใช้งานและระดับการเข้าถึงของคุณ
ตัวเลือก API
แพลตฟอร์มนี้ประกอบด้วยจุดสิ้นสุด REST และเลเยอร์ที่เข้ากันได้กับ GraphQL แบบน้ำหนักเบา พร้อมการรองรับคีย์ API, ข้อมูลรับรองไคลเอ็นต์ OAuth, การวิเคราะห์การใช้งาน, ขีดจำกัดอัตรา และการนำส่ง Webhook ที่ลงนาม คุณลักษณะของเว็บไซต์สาธารณะบางรายการอาจไม่พร้อมใช้งานโดยอัตโนมัติผ่าน API
การรับรองความถูกต้อง
ตำแหน่งข้อมูล REST v1 สามารถใช้คีย์ API ในไฟล์ X-API-Key ส่วนหัว จุดสิ้นสุดที่ใหม่กว่าอาจยอมรับโทเค็นผู้ถือที่รองรับด้วย เก็บความลับทั้งหมดไว้และหมุนคีย์ทันทีหากมีการเปิดเผย
curl -H "X-API-Key: qc_your_key" "https://gettoolslab.com/api/v1/tools.php"
จุดสิ้นสุด REST ทั่วไป
เครื่องมือs
GET /api/v1/tools.php
GET /api/v1/tools.php?category=PDF
GET /api/v1/tools.php?q=json
คู่มือs
GET /api/v1/guides.php
GET /api/v1/guides.php?q=image
REST v2 และ GraphQL
แพลตฟอร์มนักพัฒนาที่รวมเข้าด้วยกันสามารถเปิดเผยเส้นทาง REST ที่ใหม่กว่าและการดำเนินการ GraphQL สำหรับทรัพยากรที่รองรับ ใช้พื้นที่การแก้ไขและสนามเด็กเล่น API เพื่อดูจุดสิ้นสุดที่เปิดใช้งานจริงในการปรับใช้ปัจจุบัน
ขีดจำกัดอัตรา
คำขอ API อาจถูกจำกัดต่อนาทีหรือต่อวัน คำขอที่เกินขีดจำกัดสามารถส่งคืน HTTP ได้ 429 Too Many Requests พร้อมกับลองใหม่หรือรีเซ็ตข้อมูล แอปพลิเคชันควรใช้ backoff แทนที่จะทำซ้ำคำขอที่ล้มเหลวทันที
เว็บฮุค
เหตุการณ์ที่รองรับสามารถส่งไปยังปลายทาง HTTPS webhook ได้ เมื่อเปิดใช้งานการลงนาม ให้ตรวจสอบลายเซ็น HMAC ก่อนที่จะเชื่อถือเพย์โหลด ผู้ใช้เว็บฮุคควรทนต่อการลองใหม่ และควรทำการประมวลผลเหตุการณ์ idempotent เพื่อที่การนำส่งเดียวกันจะไม่สร้างการดำเนินการที่ซ้ำกัน
ข้อผิดพลาดs
ข้อมูลประจำตัวที่ไม่ถูกต้อง ไคลเอ็นต์ที่ถูกปิดใช้งาน โควต้าที่ใช้หมดแล้ว หรือคำขอที่มีรูปแบบไม่ถูกต้องสามารถส่งคืนข้อผิดพลาด JSON ที่มีโครงสร้างด้วยรหัสสถานะ HTTP 4xx ความล้มเหลวฝั่งเซิร์ฟเวอร์ใช้การตอบสนอง 5xx แอปพลิเคชันควรบันทึกสถานะการตอบสนองและขอตัวระบุหากมี แทนที่จะเปิดเผยข้อมูลประจำตัวที่เป็นความลับในรายงานข้อผิดพลาด
ความปลอดภัย guidance
- ห้ามฝังคีย์ API ลับใน JavaScript ของเบราว์เซอร์สาธารณะ
- ใช้ HTTPS สำหรับการรับส่งข้อมูล API และเว็บฮุค
- ให้สิทธิ์แก่ลูกค้าตามที่ต้องการเท่านั้น
- ตรวจสอบลายเซ็นเว็บฮุค
- หมุนเวียนข้อมูลรับรองที่ถูกบุกรุก
- เคารพขีดจำกัดอัตราและขีดจำกัดขนาดไฟล์ที่บันทึกไว้
SDK และ Playground
ไปที่ส่วนหมาป่าเพื่อดูตัวอย่าง SDK และสนามเด็กเล่นแบบโต้ตอบ ทดสอบการผสานรวมกับข้อมูลที่ไม่ละเอียดอ่อนก่อนใช้ไฟล์ที่ใช้งานจริงหรือข้อมูลลูกค้า