ऑटोमेशन आणि डेव्हलपर्स

REST API

प्रोग्रामद्वारे कॅम्पेन, अर्ज आणि वापरकर्ते पाहा व व्यवस्थापित करा.

PeekHire REST API मुळे तुमचे सॉफ्टवेअर भरतीशी संबंधित डेटासोबत काम करू शकते. हे मानक HTTPS + JSON API आहे, त्यामुळे वेब रिक्वेस्ट पाठवू शकणारी कोणतीही भाषा किंवा टूल याचा वापर करू शकते.

इंटरॲक्टिव्ह OpenAPI संदर्भामध्ये प्रत्येक एंडपॉइंट, पॅरामीटर आणि स्कीमा पाहा:

API संदर्भ उघडा

बेस URL आणि व्हर्जनिंग

API ला व्हर्जनिंग आहे. भविष्यातील बदलांमुळे तुमचे इंटिग्रेशन बिघडू नये म्हणून सर्व एंडपॉइंट /api/v1 प्रिफिक्सखाली आहेत.

ऑथेंटिकेशन

बेअरर टोकन म्हणून पाठवलेली API की वापरून प्रत्येक रिक्वेस्टचे ऑथेंटिकेशन करा:

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

क्लायंट-साइड कोडमध्ये किंवा सार्वजनिक रिपॉझिटरीमध्ये API की कधीही ठेवू नका.

तुम्ही काय ॲक्सेस करू शकता

v1 API मध्ये भरतीशी संबंधित मुख्य ऑब्जेक्ट्सचा समावेश आहे:

कॅम्पेन — तुम्ही ज्या पदांसाठी भरती करत आहात, त्यांची यादी पाहा आणि तपशील मिळवा.
अर्ज — उमेदवारांनी सादर केलेल्या अर्जांची यादी पाहा आणि तपशील मिळवा.
वापरकर्ते — तुमच्या वर्कस्पेसमधील सदस्यांची यादी पाहा आणि तपशील मिळवा.

रिस्पॉन्स JSON स्वरूपात असतात आणि ॲपमध्ये दिसणारी फील्ड्स त्यात असतात. उदाहरणार्थ, कॅम्पेनचे शीर्षक आणि स्थिती किंवा अर्जाचा टप्पा आणि भाषा.

पेजिनेशन आणि फिल्टरिंग

यादी दाखवणारे एंडपॉइंट्स निकाल पेजेसमध्ये परत करतात. मोठ्या निकालांमधून पुढे जाण्यासाठी पेजिनेशन पॅरामीटर्स वापरा. जिथे फिल्टरिंग उपलब्ध आहे, तिथे तुम्हाला हवे तेवढेच निकाल मिळवण्यासाठी फिल्टर वापरा.

API मध्ये मानक HTTP स्टेटस कोड वापरले जातात — यशस्वी रिक्वेस्टसाठी 2xx, तुमच्या रिक्वेस्टमधील समस्यांसाठी 4xx (उदाहरणार्थ, की नसणे किंवा अवैध की), आणि अनपेक्षित सर्व्हर त्रुटींसाठी 5xx. काय चूक झाली हे सांगणारा संदेश त्रुटीच्या रिस्पॉन्समध्ये असतो.