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. ఏమి తప్పు జరిగిందో వివరించే సందేశం ఎర్రర్ ప్రతిస్పందనల్లో ఉంటుంది.
సంబంధితవి
- API కీలు
- పోలింగ్‌కు బదులుగా పుష్ నోటిఫికేషన్‌ల కోసం వెబ్‌హుక్‌లు