REST API

Το PeekHire REST API επιτρέπει στο δικό σου λογισμικό να δουλεύει με τα δεδομένα προσλήψεών σου. Είναι ένα τυπικό HTTPS + JSON API, οπότε μπορεί να το χρησιμοποιήσει οποιαδήποτε γλώσσα ή εργαλείο μπορεί να κάνει αιτήματα web.

Εξερεύνησε κάθε endpoint, παράμετρο και σχήμα στο διαδραστικό OpenAPI reference:

Βασικό URL και διαχείριση εκδόσεων

Το API είναι εκδομένο. Όλα τα endpoints βρίσκονται κάτω από το πρόθεμα /api/v1, ώστε οι μελλοντικές αλλαγές να μην σπάσουν την ενσωμάτωσή σου.

Έλεγχος ταυτότητας

Πραγματοποίησε έλεγχο ταυτότητας σε κάθε αίτημα με ένα κλειδί API που αποστέλλεται ως bearer token:

curl https://your-api-host/api/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY"

Μην ενσωματώνεις ποτέ κλειδί API σε κώδικα client-side ή σε δημόσιο repository.

Σε τι έχεις πρόσβαση

Το API v1 καλύπτει τα βασικά αντικείμενα προσλήψεων:

• Καμπάνιες — εμφάνισε και ανάκτησε τους ρόλους για τους οποίους κάνεις προσλήψεις.
• Αιτήσεις — εμφάνισε και ανάκτησε τις υποβολές υποψηφίων.
• Χρήστες — εμφάνισε και ανάκτησε τα μέλη του workspace σου.

Οι απαντήσεις είναι σε JSON και περιλαμβάνουν τα πεδία που βλέπεις στην εφαρμογή, όπως τον τίτλο και την κατάσταση μιας καμπάνιας ή το στάδιο και τη γλώσσα μιας αίτησης.

Σελιδοποίηση και φιλτράρισμα

Τα endpoints λίστας επιστρέφουν αποτελέσματα σε σελίδες. Χρησιμοποίησε τις παραμέτρους σελιδοποίησης για να περιηγηθείς σε μεγάλα σύνολα αποτελεσμάτων και φιλτράρισε όπου υποστηρίζεται, ώστε να λαμβάνεις μόνο ό,τι χρειάζεσαι.

Σφάλματα

Το API χρησιμοποιεί τυπικούς κωδικούς κατάστασης HTTP — 2xx για επιτυχία, 4xx για προβλήματα με το αίτημά σου (όπως κλειδί που λείπει ή δεν είναι έγκυρο) και 5xx για απρόσμενα σφάλματα διακομιστή. Οι απαντήσεις σφάλματος περιλαμβάνουν ένα μήνυμα που περιγράφει τι πήγε στραβά.

Σχετικά

• Κλειδιά API
• Webhooks για push ειδοποιήσεις αντί για polling