PeekHire logosu
Otomasyon ve geliştiriciler

REST API

Kampanyaları, başvuruları ve kullanıcıları programatik olarak okuyup yönetin.

PeekHire REST API, kendi yazılımınızın işe alım verilerinizle çalışmasını sağlar. Bu, standart bir HTTPS + JSON API’dir; web isteği gönderebilen herhangi bir dil veya araç onu kullanabilir.

İnteraktif OpenAPI referansında tüm endpoint’leri, parametreleri ve şemaları keşfedin:

API referansını aç

Temel URL ve sürümleme

API sürümlendirilmiştir. Tüm endpoint’ler /api/v1 ön eki altında yer alır; böylece gelecekteki değişiklikler entegrasyonunuzu bozmaz.

Kimlik doğrulama

Her istekte bearer token olarak gönderilen bir API anahtarı ile kimlik doğrulaması yapın:

curl https://your-api-host/api/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY"

API anahtarını asla istemci tarafı koda veya herkese açık bir depoya eklemeyin.

Erişebilecekleriniz

v1 API, temel işe alım nesnelerini kapsar:

  • Kampanyalar — işe alım yaptığınız rolleri listeleyin ve görüntüleyin.
  • Başvurular — aday gönderimlerini listeleyin ve görüntüleyin.
  • Kullanıcılar — çalışma alanınızdaki üyeleri listeleyin ve görüntüleyin.

Yanıtlar JSON formatındadır ve uygulamada gördüğünüz alanları içerir; örneğin bir kampanyanın başlığı ve durumu ya da bir başvurunun aşaması ve dili.

Sayfalama ve filtreleme

Liste endpoint’leri sonuçları sayfalar halinde döndürür. Büyük sonuç kümelerinde gezinmek için sayfalama parametrelerini kullanın ve yalnızca ihtiyacınız olanı almak için desteklenen yerlerde filtreleyin.

Hatalar

API standart HTTP durum kodlarını kullanır: başarı için 2xx, isteğinizle ilgili sorunlar (eksik veya geçersiz anahtar gibi) için 4xx, beklenmeyen sunucu hataları için 5xx. Hata yanıtları, neyin yanlış gittiğini açıklayan bir mesaj içerir.

İlgili

Genel bakış

PeekHire'ı API, webhook'lar, kodsuz araçlar veya bir yapay zekâ asistanıyla otomatikleştirin.

API anahtarları

API erişiminin kimliğini doğrulayan anahtarları oluşturun, kapsamlarını belirleyin ve yenileyin.