REST API
The PeekHire REST API memungkinkan software Anda bekerja dengan data rekrutmen Anda. Ini adalah API HTTPS + JSON standar, jadi bahasa atau tool apa pun yang dapat membuat web request bisa menggunakannya.
Jelajahi setiap endpoint, parameter, dan skema di referensi OpenAPI interaktif:
Buka referensi APIURL dasar dan versioning
API ini memiliki versi. Semua endpoint berada di bawah prefiks /api/v1 sehingga perubahan di masa mendatang tidak akan merusak integrasi Anda.
Autentikasi
Autentikasikan setiap request dengan API key yang dikirim sebagai bearer token:
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
Jangan pernah menyematkan API key di kode sisi klien atau repositori publik.
Yang bisa Anda akses
API v1 mencakup objek rekrutmen inti:
- Campaigns — lihat daftar dan ambil detail posisi yang sedang Anda rekrut.
- Applications — lihat daftar dan ambil detail lamaran kandidat.
- Users — lihat daftar dan ambil detail anggota workspace Anda.
Respons berupa JSON dan mencakup field yang Anda lihat di aplikasi, seperti judul dan status campaign atau tahap dan bahasa application.
Paginasi dan filtering
Endpoint daftar mengembalikan hasil dalam beberapa halaman. Gunakan parameter paginasi untuk menelusuri kumpulan hasil yang besar, dan filter jika didukung untuk mengambil hanya yang Anda butuhkan.
Error
API menggunakan kode status HTTP standar — 2xx untuk berhasil, 4xx untuk masalah pada request Anda (seperti key yang hilang atau tidak valid), dan 5xx untuk error server yang tidak terduga. Respons error menyertakan pesan yang menjelaskan apa yang terjadi.