Skava Skava / Wiki

Προσαρμοσμένα Στοιχεία: API

Μια διεπαφή API είναι ένα έντυπο του οποίου τις συμπληρωμένες τιμές η Skava στέλνει ως JSON σε μια διεύθυνση που καθορίζετε (το backend σας). Με αυτόν τον τρόπο μπορείτε να συνδέσετε τη Skava με ασφάλεια με τα δικά σας συστήματα.

i

Διαχειρίζεστε τις διεπαφές API στον Ιστότοπο κάτω από Προσαρμοσμένα Στοιχεία → εναλλαγή API Interfaces. Η δημιουργία και η επεξεργασία είναι δεσμευμένες για διαχειριστές εταιρείας· οι απελευθερωμένες διεπαφές μπορούν στη συνέχεια να ενεργοποιηθούν από όλα τα μέλη της εταιρείας.

Ρύθμιση διεπαφής API

Μια διεπαφή αποτελείται από πεδία εισαγωγής (αυτά σχηματίζουν το JSON), τη διεύθυνση στόχου και την πιστοποίηση.

  1. Δημιουργήστε πεδία: Κάθε πεδίο παίρνει ένα κλειδί JSON. Στα δεξιά βλέπετε ζωντανά την προεπισκόπηση JSON, η οποία αποστέλλεται στο backend σας ακριβώς έτσι.
  2. Διεύθυνση (URL): η διεύθυνση https:// του backend σας. Επιτρέπονται μόνο HTTPS και δημόσιες διευθύνσεις (δείτε Ασφάλεια παρακάτω).
  3. Μέθοδος: POST (προεπιλογή), PUT, PATCH ή GET. Με GET οι τιμές προσαρτώνται ως παράμετροι ερωτήματος αντί να αποστέλλονται στο σώμα.
  4. Πιστοποίηση: Ορίστε το όνομα κεφαλίδας (π.χ. Authorization) και πρόθεμα τιμής (π.χ. Bearer ), στη συνέχεια αποθηκεύστε το token. Προαιρετικά ορίστε μια ημερομηνία λήξης.
  5. Πεδία απόκρισης (προαιρετικό): Ορίστε κατά τη διαδρομή ποιες τιμές από την απόκριση backend θα εμφανιστούν — π.χ. order.id ή items[0].sku.
  6. Ελέγξτε με Ping και Δοκιμή Αίτησης, στη συνέχεια Απελευθέρωση.

Αποθηκεύστε το token με Ασφάλεια

Το token αποθηκεύεται κρυπτογραφημένο και δεν επιστρέφεται ποτέ στα πελάτη — η εφαρμογή εμφανίζει μόνο εάν έχει οριστεί ένα token και πότε λήγει. Κατά την αποστολή, η Skava το προσαρτά server-side στην κεφαλίδα που ρυθμίστηκε. Εάν ορίσετε μια ημερομηνία λήξης, η Skava αρνείται την κλήση μετά τη λήξη και σας ζητά να ανανεώσετε το token.

Δοκιμή: Ping και Δοκιμή Αίτησης

  • Ping — ένας ελαφρύς έλεγχος δυνατότητας επίτευξης. Ελέγχει μόνο εάν η διεύθυνσή σας αποκρίνεται και δεν αποστέλνει token ή δεδομένα φόρμας στη διαδικασία. Εμφανίζει δυνατότητα επίτευξης, κατάσταση και χρόνο απόκρισης. Ιδανικό ως πρώτο βήμα.
  • Δοκιμή Αίτησης — η πραγματική δοκιμή: αποστέλνει δεδομένα δείγματος συμπεριλαμβανομένου του token στη διεύθυνσή σας και εμφανίζει την πλήρη απόκριση καθώς και τα εξαγόμενα πεδία απόκρισης.

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

Σχέδιο και Απελευθέρωση

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

!

Οι απελευθερωμένες διεπαφές είναι αμετάβλητες. Αυτό είναι σκόπιμο: ώστε μετά την απελευθέρωση κανένας δεν μπορεί κρυφά να αλλάξει τη διεύθυνση στόχου ή το token. Για αλλαγές, δημιουργήστε μια νέα έκδοση.

Ασφάλεια

i

Για να αποτρέψετε τη λανθασμένη χρήση της διεπαφής, ισχύουν αυστηροί κανόνες: μόνο διευθύνσεις HTTPS επιτρέπονται και η διεύθυνση πρέπει να δείχνει σε μια δημόσια διεύθυνση στόχου — οι εσωτερικές διευθύνσεις (π.χ. localhost, ιδιωτικά δίκτυα ή μεταδεδομένα νέφους) απορρίπτονται. Η Skava ελέγχει αυτό σε κάθε κλήση, συνδέεται ακριβώς στη δεδομένη διεύθυνση, δεν ακολουθεί ανακατευθύνσεις και περιορίζει το timeout και το μέγεθος απόκρισης.

Σχετικά

Θέλετε αντί να δημιουργήσετε ένα πρότυπο εγγράφου που μπορεί να συμπληρωθεί; Δείτε Προσαρμοσμένα Στοιχεία: Έγγραφα.

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

Τι είναι μια διεπαφή API στη Skava;

Ένα έντυπο του οποίου τις συμπληρωμένες τιμές η Skava στέλνει ως JSON σε μια διεύθυνση που καθορίζετε (το backend σας) — βολικό για σύνδεση Skava με τα δικά σας συστήματα.

Ποιος επιτρέπεται να δημιουργήσει και να ενεργοποιήσει διεπαφές API;

Η δημιουργία και η επεξεργασία είναι δεσμευμένες για διαχειριστές εταιρείας. Μια απελευθερωμένη διεπαφή μπορεί στη συνέχεια να ενεργοποιηθεί από όλα τα μέλη της εταιρείας.

Ποια είναι η διαφορά μεταξύ "Ping" και "Δοκιμή Αίτησης";

Ping ελέγχει μόνο εάν η διεύθυνση είναι προσβάσιμη — χωρίς token και χωρίς δεδομένα. Δοκιμή Αίτησης αποστέλνει δεδομένα δείγματος συμπεριλαμβανομένου του token και εμφανίζει την πλήρη απόκριση.

Είναι το token API μου ασφαλές;

Ναι. Το token αποθηκεύεται κρυπτογραφημένο και δεν παραδίνεται ποτέ στα πελάτη. Η εφαρμογή εμφανίζει μόνο εάν έχει οριστεί ένα token και πότε λήγει.

Ποιες διευθύνσεις επιτρέπονται ως endpoints;

Μόνο δημόσιες https:// διευθύνσεις. Οι εσωτερικοί στόχοι όπως localhost, ιδιωτικά δίκτυα ή μεταδεδομένα νέφους απορρίπτονται — αυτό προστατεύει από κακή χρήση της διεπαφής.

Γιατί δεν μπορώ πλέον να αλλάξω μια απελευθερωμένη διεπαφή;

Οι απελευθερωμένες διεπαφές είναι σκόπιμα αμετάβλητες — ώστε μετά την απελευθέρωση κανένας δεν μπορεί να αλλάξει τη διεύθυνση στόχου ή το token. Για αλλαγές, δημιουργήστε μια νέα έκδοση.