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 ಕೀಗಳು
- ಪೋಲಿಂಗ್ ಬದಲಿಗೆ ಪುಶ್ ಅಧಿಸೂಚನೆಗಳಿಗಾಗಿ ವೆಬ್‌ಹುಕ್‌ಗಳು