REST API
PeekHire REST API से आपका सॉफ्टवेयर आपके भर्ती डेटा के साथ काम कर सकता है। यह एक स्टैंडर्ड HTTPS + JSON API है, इसलिए वेब रिक्वेस्ट भेजने वाली कोई भी भाषा या टूल इसका इस्तेमाल कर सकता है।
इंटरैक्टिव OpenAPI रेफ़रेंस में हर endpoint, parameter और schema देखें:
API रेफ़रेंस खोलेंबेस URL और वर्ज़निंग
API वर्ज़न के साथ आती है। सभी endpoint /api/v1 प्रीफ़िक्स के तहत हैं, ताकि आगे
होने वाले बदलाव आपके इंटीग्रेशन को प्रभावित न करें।
ऑथेंटिकेशन
हर रिक्वेस्ट को bearer token के रूप में भेजी गई API key से ऑथेंटिकेट करें:
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
API key को क्लाइंट-साइड कोड या सार्वजनिक रिपॉज़िटरी में कभी न रखें।
आप क्या एक्सेस कर सकते हैं
v1 API में भर्ती से जुड़े मुख्य ऑब्जेक्ट शामिल हैं:
- कैंपेन — उन पदों की सूची देखें और जानकारी पाएँ जिनके लिए आप भर्ती कर रहे हैं।
- आवेदन — उम्मीदवारों के सबमिशन की सूची देखें और जानकारी पाएँ।
- यूज़र — अपने वर्कस्पेस के सदस्यों की सूची देखें और जानकारी पाएँ।
जवाब JSON में मिलते हैं और उनमें ऐप में दिखने वाले फ़ील्ड शामिल होते हैं, जैसे कैंपेन का टाइटल और स्टेटस या आवेदन का चरण और भाषा।
पेजिनेशन और फ़िल्टरिंग
लिस्ट endpoint के नतीजे पेज में मिलते हैं। बड़े नतीजों को पेजों में देखने के लिए पेजिनेशन पैरामीटर इस्तेमाल करें। जहाँ फ़िल्टर का विकल्प हो, वहाँ सिर्फ़ ज़रूरी नतीजे पाने के लिए फ़िल्टर करें।
एरर
API स्टैंडर्ड HTTP स्टेटस कोड इस्तेमाल करती है — सफलता के लिए 2xx, आपकी रिक्वेस्ट
में समस्याओं के लिए 4xx (जैसे, key का न होना या अमान्य होना), और सर्वर की
अनपेक्षित गड़बड़ियों के लिए 5xx। एरर रिस्पॉन्स में गड़बड़ी की जानकारी देने वाला
मैसेज शामिल होता है।