REST API
PeekHire REST API மூலம் உங்கள் சொந்த மென்பொருள், உங்கள் ஆட்சேர்ப்புத் தரவுடன் செயல்படலாம். இது வழக்கமான HTTPS + JSON API என்பதால், இணையக் கோரிக்கைகளை அனுப்பக்கூடிய எந்த மொழி அல்லது கருவியும் இதைப் பயன்படுத்தலாம்.
ஊடாடும் OpenAPI குறிப்பில் ஒவ்வொரு endpoint, அளவுரு மற்றும் 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-ஐ client-side குறியீட்டிலோ பொதுக் களஞ்சியத்திலோ ஒருபோதும் சேர்க்காதீர்கள்.
நீங்கள் அணுகக்கூடியவை
v1 API, ஆட்சேர்ப்பின் முக்கியத் தரவுப் பொருள்களை வழங்குகிறது:
- கேம்பெயின்கள் — நீங்கள் ஆட்சேர்ப்பு செய்யும் பணிகளைப் பட்டியலிட்டு, அவற்றைப் பெறுங்கள்.
- விண்ணப்பங்கள் — விண்ணப்பதாரர்களின் சமர்ப்பிப்புகளைப் பட்டியலிட்டு, அவற்றைப் பெறுங்கள்.
- பயனர்கள் — உங்கள் வொர்க்ஸ்பேஸின் உறுப்பினர்களைப் பட்டியலிட்டு, அவர்களின் விவரங்களைப் பெறுங்கள்.
பதில்கள் JSON வடிவில் இருக்கும். கேம்பெயினின் தலைப்பு மற்றும் நிலை, அல்லது விண்ணப்பத்தின் நிலை மற்றும் மொழி போன்ற ஆப்பில் நீங்கள் பார்க்கும் புலங்களும் அவற்றில் இடம்பெறும்.
பக்கங்களாகப் பிரித்தல் மற்றும் வடிகட்டுதல்
பட்டியல் endpoint-கள் முடிவுகளைப் பக்கங்களாக வழங்கும். பெரிய முடிவுத் தொகுப்புகளைப் பக்கங்களாகப் பெறப் பக்கமாக்கல் அளவுருக்களைப் பயன்படுத்துங்கள். ஆதரிக்கப்படும் இடங்களில், உங்களுக்குத் தேவையானவற்றை மட்டும் பெற வடிகட்டுங்கள்.
பிழைகள்
API வழக்கமான HTTP நிலைக் குறியீடுகளைப் பயன்படுத்துகிறது — வெற்றிக்கு 2xx, உங்கள் கோரிக்கையில் உள்ள சிக்கல்களுக்கு (விசை விடுபட்டிருப்பது அல்லது செல்லாததாக இருப்பது போன்றவை) 4xx, எதிர்பாராத சர்வர் பிழைகளுக்கு 5xx. என்ன தவறு நடந்தது என்பதை விவரிக்கும் செய்தியும் பிழைப் பதில்களில் இடம்பெறும்.
தொடர்புடையவை
- API விசைகள்
- வெப்ஹூக்குகள் — மீண்டும் மீண்டும் கோருவதற்குப் பதிலாக, நிகழ்வு அறிவிப்புகளைப் பெறுவதற்கு