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. ભૂલના જવાબોમાં શું ખોટું થયું તે સમજાવતો સંદેશ હોય છે.