Partner API: διαχείριση κλειδιών και webhooks
Με το Partner API συνδέεις δικές σου σελίδες κρατήσεων, εφαρμογές και ενσωματώσεις με τη STRYK. Δημιουργείς κλειδιά με ακριβώς τα δικαιώματα που χρειάζονται και ρυθμίζεις webhooks.
Contents
Πριν ξεκινήσεις
- Χρειάζεσαι το δικαίωμα Διαχείριση channels. Μόνο τότε βλέπεις τη γραμμή API στη σελίδα Κανάλια.
- Διευκρίνισε ποιες περιοχές πρέπει η ενσωμάτωση να διαβάζει ή να γράφει. Ένα κλειδί παίρνει μόνο αυτά τα δικαιώματα.
- Μια ενσωμάτωση καλεί το Partner API από τον δικό της server. Το κλειδί δεν το βάζεις ποτέ σε κώδικα browser ή σε εφαρμογή. Τα endpoints, οι παράμετροι και τα παραδείγματα βρίσκονται στην Τεκμηρίωση για προγραμματιστές. Εκεί η ενότητα Πιστοποίηση και scopes εξηγεί τι επιτρέπει κάθε δικαίωμα.
- Τα webhooks χρειάζονται παραλήπτη με διεύθυνση που ξεκινά με https://.
Άνοιγμα του API
In STRYKΚανάλια
- Επίλεξε στις Δικές σου διασυνδέσεις τη γραμμή API με την προσθήκη „Κλειδιά API και webhooks“. Ανοίγει ο διάλογος API.
- Επίλεξε την καρτέλα Κλειδιά API ή Webhooks. Με Τεκμηρίωση για προγραμματιστές στην κεφαλίδα του διαλόγου ανοίγεις την πύλη προγραμματιστών.
- Καρτέλες Κλειδιά API και Webhooks
- Κλειδιά με δικαιώματα
- Ενέργειες του κλειδιού
Δημιουργία κλειδιού API
In STRYKΚανάλιαAPIΚλειδιά API
- Επίλεξε Δημιουργία κλειδιού API. Ανοίγει ο διάλογος Δημιουργία κλειδιού API.
- Συμπλήρωσε το Όνομα, για παράδειγμα „Σελίδα κρατήσεων“.
- Επίλεξε στα Δικαιώματα ένα μοτίβο: Μόνο ανάγνωση (ανάγνωση όλων των περιοχών), Ανάγνωση και εγγραφή (εγγραφή όπου είναι δυνατό) ή Προσαρμοσμένη. Με Προσαρμοσμένη επιλέγεις για κάθε περιοχή Χωρίς πρόσβαση, Ανάγνωση ή Εγγραφή. Οι περιοχές είναι Ξενοδοχείο & δωμάτια, Διαθεσιμότητα, Τιμές & rate plans, Κρατήσεις, Επισκέπτες, Πληρωμές και Τιμολόγια. Η Εγγραφή περιλαμβάνει την Ανάγνωση. Τα τιμολόγια είναι φορολογικά παραστατικά του ξενοδοχείου και μπορούν να διαβαστούν μόνο μέσω API.
- Προαιρετικά: άνοιξε τα Προχωρημένα. Επίλεξε τη Λήξη: Χωρίς λήξη, 30 ημέρες, 90 ημέρες, 1 έτος ή Ημερομηνία (από αύριο, το πολύ σε τρία χρόνια). Βάλε στον Περιορισμός IP σε κάθε γραμμή μια διεύθυνση ή ένα δίκτυο CIDR, το πολύ 20. Κενό σημαίνει ότι επιτρέπονται όλες οι διευθύνσεις. Στη Σημείωση κρατάς μια εσωτερική υπενθύμιση.
- Επίλεξε Δημιουργία. Η STRYK εμφανίζει Το κλειδί API δημιουργήθηκε με το κλειδί και την ένδειξη Εμφανίζεται μόνο τώρα.
- Αντέγραψε το κλειδί και αποθήκευσέ το, για παράδειγμα, σε διαχειριστή κωδικών πρόσβασης. Επίλεξε Έγινε.
Διαχείριση κλειδιών
In STRYKΚανάλιαAPIΚλειδιά API
Η λίστα δείχνει για κάθε κλειδί το Όνομα, την αρχή του κλειδιού, τα Δικαιώματα, τα Δημιουργήθηκε, Τελευταία χρήση, τη Λήξη και την κατάσταση: Ενεργά, Λήγει σύντομα, Ανακλήθηκε ή Έληξε. Επίλεξε ένα κλειδί για να δεις τα Δικαιώματα, τη Λήξη, τις Επιτρεπόμενες διευθύνσεις IP, το Όριο ρυθμού (αιτήματα ανά λεπτό), τη Χρήση, τα Τελευταία αιτήματα και το Ιστορικό.
- Άνοιξε στη γραμμή το μενού Επιλογές.
- Επίλεξε Δημιουργία νέου, όταν η ενσωμάτωση πρέπει να πάρει νέο κλειδί με τα ίδια δικαιώματα. Στο Τρέχον κλειδί επίλεξε Το παλιό κλειδί ισχύει ακόμη 24 ώρες, ώστε να προλάβεις να αλλάξεις την ενσωμάτωση, ή Ανάκληση αμέσως. Επιβεβαίωσε με Δημιουργία νέου. Η STRYK εμφανίζει το νέο κλειδί μία φορά.
- Επίλεξε Ανάκληση και επιβεβαίωσε με Ανάκληση κλειδιού API; για να κλειδώσεις ένα κλειδί αμέσως. Η STRYK απορρίπτει τα αιτήματα με αυτό το κλειδί.
Ρύθμιση webhooks
In STRYKΚανάλιαAPIWebhooks
Ένα webhook στέλνει τα επιλεγμένα συμβάντα υπογεγραμμένα μέσω HTTPS στα συστήματά σου.
- Επίλεξε Δημιουργία webhook. Ανοίγει ο διάλογος Νέο webhook.
- Βάλε τη URL παραλήπτη, για παράδειγμα https://crm.nordlicht.invalid/hooks/stryk. Η διεύθυνση πρέπει να ξεκινά με https://.
- Προαιρετικά: συμπλήρωσε μια Περιγραφή, για παράδειγμα „Κρατήσεις στο δικό μας CRM“.
- Επίλεξε στα Συμβάντα τουλάχιστον ένα: Η κράτηση δημιουργήθηκε, Η κράτηση άλλαξε, Η κράτηση ακυρώθηκε, Ο επισκέπτης άλλαξε, Η διαθεσιμότητα άλλαξε, Η τιμή άλλαξε, Η πληρωμή άλλαξε ή Η κατάσταση δωματίου άλλαξε. Με Επίλεξε όλα και Κατάργηση επιλογής επιλέγεις όλα ή κανένα.
- Επίλεξε Δημιουργία webhook. Η STRYK εμφανίζει μία φορά το Το μυστικό υπογραφής σου.
- Αποθήκευσε το μυστικό στον παραλήπτη σου. Πώς ο παραλήπτης ελέγχει την υπογραφή, το περιγράφει η τεκμηρίωση για προγραμματιστές στο Webhooks και έλεγχος υπογραφής.
- Επίλεξε το webhook και μετά Αποστολή δοκιμαστικού συμβάντος. Η STRYK εμφανίζει „Το δοκιμαστικό συμβάν αποστέλλεται.“
Διαχείριση webhooks
Ort: Κανάλια > API > Webhooks, επιλογή webhook
- Με τον διακόπτη Παράδοση ενεργή παύεις ή ενεργοποιείς το webhook. Τα webhooks σε παύση δεν λαμβάνουν συμβάντα. Μετά την ενεργοποίηση η παράδοση ξεκινά με νέα συμβάντα.
- Τα Τελευταίες 7 ημέρες, Τελευταία επιτυχία και Τελευταίο σφάλμα δείχνουν την κατάσταση. Στις Αποστολές βλέπεις κάθε παράδοση με Κατάσταση HTTP και Προσπάθειες. Με Αποστολή ξανά επαναλαμβάνεις μια παράδοση.
- Με Ανανέωση μυστικού δημιουργείς νέο μυστικό. Το προηγούμενο ισχύει ακόμη 24 ώρες, ώστε να προλάβεις να αλλάξεις τον παραλήπτη.
- Με Επεξεργασία αλλάζεις τη διεύθυνση και τα συμβάντα, με Διαγραφή και την επιβεβαίωση Διαγραφή webhook; το αφαιρείς. Το αρχείο παράδοσης κρατιέται 30 ημέρες.
Έλεγξε το αποτέλεσμα
- Στο κλειδί εμφανίζεται η Τελευταία χρήση με ημερομηνία, μόλις η ενσωμάτωση το χρησιμοποιήσει. Το Αιτήματα 24 ώρες μετρά τα αιτήματα.
- Στο webhook η ένδειξη Τελευταίες 7 ημέρες δείχνει „{Zahl} παραδόθηκαν, {Zahl} απέτυχαν“, και το δοκιμαστικό συμβάν βρίσκεται στις Αποστολές.
Αν κάτι δεν δουλεύει
| Τι βλέπεις | Αιτία | Πώς το λύνεις |
|---|---|---|
| „Επίλεξε τουλάχιστον ένα δικαίωμα.“ | Κανένα πεδίο δεν έχει δικαίωμα. | Επίλεξε ένα μοτίβο ή δώσε σε τουλάχιστον μία περιοχή Ανάγνωση ή Εγγραφή. |
| „Βάλε ένα όνομα.“ | Το Όνομα λείπει. | Βάλε ένα όνομα. |
| „Έλεγξε:“ με μια διεύθυνση | Μια διεύθυνση στην Περιορισμός IP δεν είναι έγκυρη. | Διόρθωσε τη διεύθυνση ή το δίκτυο CIDR. Επιτρέπονται το πολύ 20 καταχωρίσεις. |
| „Επίλεξε ημερομηνία από αύριο, το πολύ σε τρία χρόνια.“ | Η ημερομηνία λήξης είναι εκτός του επιτρεπόμενου διαστήματος. | Επίλεξε ημερομηνία από αύριο που απέχει το πολύ τρία χρόνια. |
| „Η διεύθυνση πρέπει να ξεκινά με https://.“ | Η URL παραλήπτη δεν είναι διεύθυνση HTTPS. | Βάλε διεύθυνση με https://. |
| „Επίλεξε τουλάχιστον ένα συμβάν.“ | Το webhook δεν έχει συμβάν. | Επίλεξε τουλάχιστον ένα στα Συμβάντα. |
| Σε παύση λόγω επαναλαμβανόμενων σφαλμάτων | Ο παραλήπτης δεν απαντά με κατάσταση 2xx. | Έλεγξε αν ο παραλήπτης είναι προσβάσιμος και επίλεξε Ενεργοποίηση ξανά. |
| „Ενεργοποίησε το webhook για να στείλεις δοκιμαστικό συμβάν.“ | Το webhook είναι σε παύση. | Ενεργοποίησε την Παράδοση ενεργή και στείλε το δοκιμαστικό συμβάν. |
| „Η επιλογή δεν μπόρεσε να φορτωθεί. Κλείσε και άνοιξέ την ξανά.“ | Η λίστα δικαιωμάτων και συμβάντων δεν φορτώθηκε. | Κλείσε τον διάλογο και άνοιξέ τον ξανά. |