REST API
API REST của PeekHire cho phép phần mềm của bạn làm việc với dữ liệu tuyển dụng của bạn. Đây là API HTTPS + JSON tiêu chuẩn, nên bất kỳ ngôn ngữ hoặc công cụ nào có thể gửi yêu cầu web đều có thể sử dụng.
Khám phá mọi điểm cuối, tham số và schema trong tài liệu tham chiếu OpenAPI tương tác:
Mở tham chiếu APIURL cơ sở và quản lý phiên bản
API được quản lý theo phiên bản. Tất cả điểm cuối nằm dưới tiền tố /api/v1 để các thay đổi
trong tương lai không làm hỏng tích hợp của bạn.
Xác thực
Xác thực mọi yêu cầu bằng khóa API được gửi dưới dạng bearer token:
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
Không bao giờ nhúng khóa API vào mã phía client hoặc kho lưu trữ công khai.
Những gì bạn có thể truy cập
API v1 bao gồm các đối tượng tuyển dụng cốt lõi:
- Campaigns — liệt kê và truy xuất các vị trí bạn đang tuyển.
- Applications — liệt kê và truy xuất hồ sơ ứng viên gửi đến.
- Users — liệt kê và truy xuất các thành viên trong workspace của bạn.
Phản hồi ở định dạng JSON và bao gồm các trường bạn thấy trong ứng dụng, chẳng hạn như tiêu đề và trạng thái của campaign hoặc giai đoạn và ngôn ngữ của application.
Phân trang và lọc
Các điểm cuối dạng danh sách trả về kết quả theo từng trang. Dùng các tham số phân trang để duyệt qua các tập kết quả lớn, và lọc khi được hỗ trợ để chỉ lấy những gì bạn cần.
Lỗi
API sử dụng mã trạng thái HTTP tiêu chuẩn — 2xx cho thành công, 4xx cho vấn đề
với yêu cầu của bạn (chẳng hạn như thiếu khóa hoặc khóa không hợp lệ), và 5xx cho lỗi máy chủ
không mong muốn. Phản hồi lỗi bao gồm thông báo mô tả điều đã xảy ra.