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 കീകൾ
- പോളിംഗ് ചെയ്യുന്നതിന് പകരം പുഷ് അറിയിപ്പുകൾക്കായി വെബ്‌ഹുക്കുകൾ