REST API
The PeekHire REST API ช่วยให้ซอฟต์แวร์ของคุณทำงานกับข้อมูลการสรรหาบุคลากรได้ เป็น API มาตรฐานแบบ HTTPS + JSON ดังนั้นภาษาใด ๆ หรือเครื่องมือใด ๆ ที่ส่งคำขอเว็บได้ ก็ใช้งานได้
สำรวจทุก endpoint, parameter และ schema ได้ในเอกสารอ้างอิง OpenAPI แบบโต้ตอบ:
เปิดเอกสารอ้างอิง APIBase URL และการกำหนดเวอร์ชัน
API มีการกำหนดเวอร์ชัน endpoint ทั้งหมดอยู่ภายใต้ prefix /api/v1 เพื่อให้การเปลี่ยนแปลง
ในอนาคตไม่ทำให้การเชื่อมต่อของคุณเสียหาย
การยืนยันตัวตน
ยืนยันตัวตนทุกคำขอด้วย API key ที่ส่งเป็น bearer token:
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
อย่าฝัง API key ไว้ในโค้ดฝั่ง client หรือ repository สาธารณะ
สิ่งที่คุณเข้าถึงได้
v1 API ครอบคลุมออบเจ็กต์หลักด้านการสรรหาบุคลากร:
- แคมเปญ — ดูรายการและดึงข้อมูลตำแหน่งที่คุณกำลังรับสมัคร
- ใบสมัคร — ดูรายการและดึงข้อมูลการส่งใบสมัครของผู้สมัคร
- ผู้ใช้ — ดูรายการและดึงข้อมูลสมาชิกใน workspace ของคุณ
คำตอบเป็น JSON และมีฟิลด์ที่คุณเห็นในแอป เช่น ชื่อและสถานะของแคมเปญ หรือขั้นตอนและภาษาของใบสมัคร
การแบ่งหน้าและการกรอง
endpoint แบบรายการจะส่งผลลัพธ์กลับมาเป็นหน้า ๆ ใช้ parameter สำหรับการแบ่งหน้าเพื่อไล่ดู ชุดผลลัพธ์ขนาดใหญ่ และใช้การกรองเมื่อรองรับเพื่อดึงเฉพาะข้อมูลที่คุณต้องการ
ข้อผิดพลาด
API ใช้รหัสสถานะ HTTP มาตรฐาน — 2xx สำหรับความสำเร็จ, 4xx สำหรับปัญหา
กับคำขอของคุณ (เช่น key หายไปหรือไม่ถูกต้อง) และ 5xx สำหรับข้อผิดพลาดของ server
ที่ไม่คาดคิด คำตอบข้อผิดพลาดจะมีข้อความอธิบายว่าเกิดอะไรขึ้น