Σκοπός: Η μελέτη παρουσιάζει τα βήματα με τα οποία μπορεί κάποιος να δημιουργήσει [App IDs] στο Pegasus Web App και να ορίσει τα απαραίτητα δικαιώματα για επικοινωνία μέσω του Pegasus Rest Service.

Σημείωση 1: Τα διαθέσιμα endpoints καθώς και οδηγίες για αυτά μπορείτε να βρείτε εδώ .

Σημείωση 2: Για τις δοκιμές των κλήσεων στο δικό σας Rest Service προτείνουμε τη χρήση του εργαλείου Postman (μπορείτε να το κατεβάσετε εδώ) . Σε περίπτωση που εντοπίσετε ζήτημα για κάποιο endpoint μπορείτε να μας στείλετε ένα παράδειγμα της κλήσης που δοκιμάσατε από το Postman ώστε να το ελέγξουμε.

Προϋποθέσεις:

• Pegasus Web App Module Rest Service

Λειτουργία:
Βασική προϋπόθεση για την επικοινωνία με το Pegasus Web App Rest Service, είναι η δημιουργία του αντίστοιχου [App ID]. Το [App ID] περιέχει τα απαραίτητα δικαιώματα για τα διαφορετικά endpoints που μπορεί να εκτελέσει κάποιος μέσω της υπηρεσία του API. Με αυτόν το τρόπο μπορείτε δώσετε συγκεκριμένες δυνατότητες σε κάποια επικοινωνία.

Ρυθμίσεις:

Από τη διαδρομή [Toolbox->Εργαλεία Παραμετροποίησης->Παραμετροποίηση Rest Service->App Ids] μπορείτε να δημιουργήσετε μια εγγραφή για [App ID]. Για την εγγραφή σας θα ορίσετε το πεδίο [Περιγραφή] καθώς και το check [Ενεργό] ως ενεργό. Επιπλέον θα πρέπει δημιουργήσετε το αναγνωριστικό για το [App ID] σας πατώντας την επιλογή [Ενέργειες->Δημιουργία App ID] (συμπληρώνεται αυτόματα το πεδίο [App ID] με το αναγνωριστικό που θα δημιουργήσει η εφαρμογή).

Από το tab [Ενέργειες] μπορείτε να ορίσετε τι δυνατότητες επικοινωνίας θα έχει το App ID. Για κάθε endpoint μπορείτε να ορίσετε αν θα υπάρχει δυνατότητα για:

• Νέα εγγραφή (POST)
• Διαγραφή (Delete)
• Ενημέρωση (PUT)
• Προβολή (GET)

Επιπλέον, από τη διαδρομη [Toolbox->Εργαλεία Παραμετροποίησης->Παραμετροποίηση Rest Service->Βασικές Παράμετροι] και από την επιλογή [Ενεργοποίηση Log] μπορείτε να ενεργοποιήσετε την καταγραφή των επικοινωνίων που γίνονται μέσω του Rest Service. Μέσα από [Toolbox->Εργαλεία Παραμετροποίησης->Παραμετροποίηση Rest Service->Service Logs] δημιουργούνται ξεχωριστά τις εγγραφές για κάθε επικοινωνία.

Σημείωση: Προτείνουμε η επιλογή να είναι απενεργοποιημένη σε παραγωγικό περιβάλλον και η χρήση της να γίνεται στο στάδιο των δοκιμών για έλεγχο των επικοινωνιών.

Σενάριo Λειτουργίας: Hello
Έστω ότι θέλετε να δοκιμάσετε μια πρώτη επικοινωνία με το Rest Api της εφαρμογής ώστε να επιβεβαιώσετε τη λειτουργία του.
Μπορείτε να εκτελέσετε το endpoint “Hello” - /api/pegapi/hello . Προϋπόθεση για το App ID σας είναι να έχετε ορίσει ως [ΝΑΙ] το δικαίωμα:

• για Προβολή στην Ενέργεια [Hello].

Σενάριo Λειτουργίας: Αποθήκη
Έστω ότι θέλετε να δημιουργήσετε μια επικοινωνία για να δείτε τα είδη της αποθήκης. Μπορείτε να εκτελέσετε το endpoint “Αποθήκη” - /api/inventory/i00/{id} . Προϋπόθεση για το App ID σας είναι να έχετε ορίσει ως [ΝΑΙ] τα δικαιώματα:

• για Προβολή στην Ενέργεια [Αποθήκη]
• για Νέα Εγγραφή στην Ενέργεια [Σύνδεση Χρήστη]
• για Νέα Εγγραφή στην Ενέργεια [Αποσύνδεση Χρήστη]

Πριν την επικοινωνία για προβολή των ειδών θα πρέπει πρώτα να εκτελέσετε το endpoint για “Σύνδεση Χρήστη“ - /api/pegapi/login .

Εκτελώντας επιτυχώς την παραπάνω επικοινωνία θα λάβετε ως απάντηση το SID το οποίο και θα χρησιμοποιήσετε στο endpoint της Αποθήκης.

Τέλος, αφού η επικοινωνία σας ολοκληρωθεί θα πρέπει να εκτελέσετε το endpoint για “Αποσύνδεση Χρήστη” - /api/pegapi/logout .

Σημείωση: για την κλήση των περισσότερων διαθέσιμων endpoints, θα πρέπει να προηγείται η [Σύνδεση Χρήστη] ώστε να παράγεται το απαραίτητο SID και η κλήση να κλείνει με την [Αποσύνδεση Χρήστη].

Παράδειγμα κλησης μέσω curl

Επιπλεόν μπορείτε να δείτε ένα παράδειγμα για το endpoint "Σύνδεση Χρήστη" μέσω της βιβλιοθήκης curl, με τη χρήση αρχείου για τις τιμές των παραμέτρων που χρησιμοποιεί το endpoint

Το αρχείο curl_request.txt περιέχει

--header "Content-Type: application/x-www-form-urlencoded"
--data-urlencode "type=json"
--data-urlencode "appid=0667-afaa-fa3a"
--data-urlencode "username=user"
--data-urlencode "password=password"