Τεχνικά & ενσωματώσεις

Ενότητα API του eBrigade

Συνδέστε το eBrigade με το πληροφοριακό σας σύστημα

Σταματήστε να ξαναπληκτρολογείτε προσωπικό, προγράμματα και προσόντα από το ένα εργαλείο στο άλλο. Το API του eBrigade εκθέτει τα δεδομένα σας μέσω τεκμηριωμένων εισερχόμενων και εξερχόμενων ροών, ασφαλισμένων με κλειδί: το σύστημα HR (HRIS), το λογισμικό μισθοδοσίας ή η εσωτερική πύλη σας συγχρονίζονται αυτόματα, χωρίς ειδική ανάπτυξη από την πλευρά του eBrigade.

Περιλαμβάνεται σε κάθε πακέτο

Περιλαμβάνεται χωρίς επιπλέον κόστος σε κάθε πακέτο eBrigade, δοκιμή 30 ημερών χωρίς κάρτα.

Η μονάδα API σε 20 δευτερόλεπτα

Εικονογράφηση · δείγμα δεδομένων

Τι είναι η ενότητα API του eBrigade;

Κλειδιά API εισαγωγής/εξαγωγής, REST API v2 και εισερχόμενες/εξερχόμενες ροές για σύνδεση του eBrigade με το πληροφοριακό σας σύστημα. Περιλαμβάνεται χωρίς επιπλέον κόστος σε κάθε πακέτο eBrigade.

Γιατί το API;

Τα δεδομένα σας στο eBrigade μένουν απομονωμένα από τα άλλα σας εργαλεία: σύστημα HR, λογισμικό μισθοδοσίας, επιχειρησιακό λογισμικό ή διαδικτυακή πύλη. Κάθε χειροκίνητη εξαγωγή Excel, κάθε επανακαταχώριση μέλους ή προσόντος παίρνει χρόνο και τελικά δημιουργεί αποκλίσεις μεταξύ των βάσεών σας. Χωρίς προγραμματιστική πρόσβαση, οι ομάδες IT δεν έχουν αξιόπιστο τρόπο να κρατούν το eBrigade ευθυγραμμισμένο με το κεντρικό σας πληροφοριακό σύστημα.

Τι αλλάζει το API στο eBrigade

Το API εκθέτει το προσωπικό σας, τις δραστηριότητες και τις συμμετοχές, τις δεξιότητες και τις ημερομηνίες λήξης τους, τους οργανισμούς, τις εγγραφές, τις διαθεσιμότητες και απουσίες, τα χτυπήματα κάρτας, τα οχήματα και τον εξοπλισμό σας μέσω τυποποιημένων ροών. Οι προγραμματιστές σας διαβάζουν τα δεδομένα (GET) και στέλνουν δεδομένα από τα εργαλεία τρίτων (POST) με ένα απλό κλειδί. Το REST API v2 επιστρέφει συνεπές JSON, με σελιδοποίηση και αυτοτεκμηρίωση· κάθε κλήση μετριέται, έχει όριο και καταγράφεται σε πίνακα χρήσης, ενώ η πρόσβαση μπορεί να περιοριστεί μόνο στις δικές σας διευθύνσεις IP.

Λειτουργίες

Τι μπορείτε να κάνετε με API

Ένα κλειδί εισαγωγής και ένα κλειδί εξαγωγής υπό τον έλεγχό σας

Δύο χωριστά κλειδιά — ένα για εισερχόμενες ροές (εισαγωγή), ένα για εξερχόμενες (εξαγωγή) — δημιουργούνται και ανανεώνονται με ένα κλικ από τη διαχείριση. Η ανανέωση ενός παραβιασμένου κλειδιού ακυρώνει αμέσως το παλιό, χωρίς να επηρεάζει την άλλη ροή.

Εισερχόμενες ροές για συγχρονισμό των δεδομένων σας

Στείλτε το προσωπικό, τις δραστηριότητες/εκπαιδεύσεις και τις δεξιότητές σας στο eBrigade από το σύστημα HR ή τον κεντρικό σας κατάλογο. Η εισαγωγή χειρίζεται τόσο ενημερώσεις όσο και δημιουργία (create_if_not_exists) και αντιστοίχιση με εσωτερικό ή εξωτερικό αναγνωριστικό (use_external_id), συμπεριλαμβανομένων UUID.

Εξερχόμενες ροές δεδομένων για το πληροφοριακό σας σύστημα

Διαθέστε μόνο για ανάγνωση το προσωπικό σας, τις δραστηριότητες και τη συμμετοχή σε μια περίοδο, το μητρώο δεξιοτήτων και τις ημερομηνίες λήξης κάθε ατόμου, τους οργανισμούς σας, τις εγγραφές σε πληρωμένες δραστηριότητες, τη διαθεσιμότητα, τις απουσίες και τις καταγραφές ωρολογίου, καθώς και τα οχήματα και τον εξοπλισμό σας. Ιδανικό για τροφοδοσία μισθοδοσίας, αναφορών ή πίνακα business intelligence.

Σύγχρονο REST API v2 με αυτόματη τεκμηρίωση

Έλεγχος ταυτότητας μέσω της κεφαλίδας Authorization: Bearer, ενιαίες αποκρίσεις JSON {success, data, meta}, σελιδοποίηση (page, per_page), μερικές ενημερώσεις εγγραφής με PATCH, κεφαλίδες CORS και σαφείς κωδικοί HTTP. Τα endpoints, οι παράμετροι και τα παραδείγματα cURL τεκμηριώνονται απευθείας στη διεπαφή, χωρίς εξωτερική τεκμηρίωση.

Όρια και πίνακας χρήσης

Η instance έχει όριο (εξ ορισμού 10.000 αιτήματα/ημέρα και 60 αιτήματα/λεπτό ανά κλειδί) με κεφαλίδες X-RateLimit και απόκριση HTTP 429 όταν ξεπεραστεί. Ένας πίνακας ελέγχου δείχνει τα αιτήματα της ημέρας, το υπόλοιπο όριο, το τελευταίο endpoint που κλήθηκε και την ώρα της τελευταίας κλήσης.

Πρόσβαση μόνο από εγκεκριμένες διευθύνσεις IP

Ενεργοποιήστε το φιλτράρισμα διευθύνσεων IP ώστε να δέχεστε κλήσεις μόνο από εξουσιοδοτημένους διακομιστές: κάθε αίτημα από IP εκτός λίστας επιτρεπόμενων απορρίπτεται (HTTP 403), ακόμη και με έγκυρο κλειδί.

Και επίσης: Νέα δεδομένα εξαγωγής · Βιβλιοθήκη συνδέσμων

Σε εικόνες

API στην εφαρμογή

Στιγμιότυπα της πραγματικής εφαρμογής, όχι μακέτες.

eBrigade, Ενότητα API — κλειδιά api και όρια χρήσης : Ένα κλειδί για τις εισερχόμενες ροές, άλλο για τις εξερχόμενες, που ανανεώνονται με ένα κλικ, με τη σημερινή χρήση και το τρέχον όριο.
Κλειδιά API και όρια χρήσηςΈνα κλειδί για τις εισερχόμενες ροές, άλλο για τις εξερχόμενες, που ανανεώνονται με ένα κλικ, με τη σημερινή χρήση και το τρέχον όριο.
eBrigade, Ενότητα API — τα τεκμηριωμένα endpoints : Προσωπικό, δραστηριότητες, συμμετοχές, δεξιότητες, οργανισμοί, διαθεσιμότητα: κάθε πόρος με τη μέθοδο και τις παραμέτρους του.
Τα τεκμηριωμένα endpointsΠροσωπικό, δραστηριότητες, συμμετοχές, δεξιότητες, οργανισμοί, διαθεσιμότητα: κάθε πόρος με τη μέθοδο και τις παραμέτρους του.
eBrigade, Ενότητα API — έτοιμα παραδείγματα κλήσεων για αντιγραφή : Πλήρη αιτήματα για κάθε ροή: η τεχνική σας ομάδα δεν χρειάζεται να μαντέψει την αναμενόμενη μορφή.
Έτοιμα παραδείγματα κλήσεων για αντιγραφήΠλήρη αιτήματα για κάθε ροή: η τεχνική σας ομάδα δεν χρειάζεται να μαντέψει την αναμενόμενη μορφή.
Πώς λειτουργεί

Βήμα προς βήμα

  1. Δημιουργήστε τα κλειδιά API σας

    Από τον χώρο διαχείρισης, ενεργοποιήστε το API εξαγωγής και δημιουργήστε το κλειδί εξαγωγής και το token εισαγωγής με ένα κλικ. Μπορείτε να τα αναδημιουργήσετε οποτεδήποτε για να ανακαλέσετε την πρόσβαση.

  2. Κλειδώστε και δοκιμάστε την πρόσβαση

    Αν χρειάζεται, ενεργοποιήστε περιορισμό σε λίστα επιτρεπόμενων διευθύνσεων IP και δοκιμάστε τις κλήσεις σας με τα παραδείγματα cURL που παρέχει η διεπαφή για κάθε endpoint (άτομα, εκδηλώσεις, δεξιότητες, τμήματα, εγγραφές).

  3. Συνδέστε τα εργαλεία σας και παρακολουθήστε

    Το πληροφοριακό σας σύστημα αντλεί (GET) ή αποστέλλει (POST) δεδομένα μέσω των τεκμηριωμένων ροών. Ο πίνακας χρήσης δείχνει τα αιτήματα της ημέρας, το υπόλοιπο όριο και την τελευταία κλήση ώστε να παρακολουθείτε τις διασυνδέσεις σας.

Συχνές ερωτήσεις για την ενότητα

Συχνές ερωτήσεις

Μπορεί ένα εξωτερικό εργαλείο να γράφει στο ημερολόγιο συμβάντων;

Ναι. Το API v2 δέχεται ένα μήνυμα στο ημερολόγιο συμβάντων μιας δραστηριότητας (POST /api/v2/events/{id}/logbook): κείμενο, τίτλο, ώρα, σπουδαιότητα και το όνομα του εργαλείου, που εμφανίζεται ως αποστολέας. Ένα αναγνωριστικό αναφοράς κάνει την κλήση idempotent: η ίδια ειδοποίηση που στέλνεται δύο φορές δημιουργεί μία μόνο γραμμή. Το ημερολόγιο διαβάζεται από την ίδια διεύθυνση, με φίλτρο «since». Η εγγραφή απαιτεί να είναι ενεργοποιημένο το API εισαγωγής.

Σε ποιους τύπους δεδομένων υπάρχει πρόσβαση μέσω του API;

Πρόσβαση ανάγνωσης (εξερχόμενες ροές): προσωπικό, δραστηριότητες και συμμετοχή σε μια περίοδο, ο κατάλογος δεξιοτήτων και οι ημερομηνίες λήξης των δεξιοτήτων, οργανισμοί, εγγραφές σε δραστηριότητες επί πληρωμή, διαθεσιμότητα, απουσίες, καταγραφές παρουσίας, ο στόλος οχημάτων και ο εξοπλισμός. Πρόσβαση εγγραφής (εισερχόμενες ροές): εισαγωγή και ενημέρωση προσωπικού (ολόκληρη η καρτέλα ή μόνο τα πεδία που αποστέλλονται, με PATCH), εισαγωγή δραστηριοτήτων/εκπαιδεύσεων και απόδοση δεξιοτήτων.

Πόσα κλειδιά API μπορούν να δημιουργηθούν;

Το API βασίζεται σε δύο κλειδιά: ένα για την εξαγωγή (εξερχόμενες ροές) και ένα token για την εισαγωγή (εισερχόμενες ροές). Το καθένα δημιουργείται και ανανεώνεται ανεξάρτητα από τον χώρο διαχείρισης. Στο API v2, ένα μόνο κλειδί μπορεί να εξυπηρετεί και τα δύο μέσω της κεφαλίδας Authorization: Bearer.

Υπάρχει σύγχρονο REST API ή πρέπει να χρησιμοποιήσω την παλιά μορφή;

Έκδοση 2: η παλιά έκδοση 1 δεν προσφέρεται πλέον, τα endpoints της διατηρούνται μόνο για υπάρχουσες ενσωματώσεις. Το API v2 προσθέτει έλεγχο ταυτότητας Bearer, τυποποιημένο JSON {success, data, meta}, σελιδοποίηση, κεφαλίδες CORS και ρητούς κωδικούς HTTP, παραμένοντας συμβατό με τα υπάρχοντα endpoints v1.

Υπάρχουν όρια αιτημάτων;

Ναι. Από προεπιλογή η εγκατάσταση περιορίζεται σε 10.000 αιτήματα την ημέρα και κάθε κλειδί σε 60 αιτήματα το λεπτό. Οι αποκρίσεις περιλαμβάνουν κεφαλίδες X-RateLimit και επιστρέφουν κωδικό HTTP 429 όταν ξεπεραστεί το όριο. Ένας πίνακας χρήσης παρακολουθεί την κατανάλωσή σας σε πραγματικό χρόνο.

Πώς προστατεύεται η πρόσβαση στο API;

Πέρα από το κλειδί, μπορείτε να ενεργοποιήσετε περιορισμό σε λίστα επιτρεπόμενων διευθύνσεων IP: κάθε κλήση από IP εκτός λίστας απορρίπτεται (HTTP 403). Ο έλεγχος ταυτότητας γίνεται κατά προτίμηση μέσω κεφαλίδας Bearer και όχι ως απλό κείμενο στη διεύθυνση URL.

Δοκιμάστε το eBrigade με την ενότητα API

Δοκιμή eBrigade 30 ημερών · Χωρίς κάρτα · Το module περιλαμβάνεται στο πακέτο σας

Η ενότητα περιλαμβάνεται στο eBrigade Δοκιμή eBrigade 30 ημερών · Χωρίς κάρτα · Περιλαμβάνεται στο πακέτο
Δωρεάν δοκιμή 30 ημερών