Για την επιτυχή επικοινωνία της εξωτερικής εφαρμογή με το API της εφαρμογής Pylon υπάρχουν κάποιοι υποχρεωτικοί παράμετροι, οι οποίοι πρέπει να αποστέλλονται σε JSON μορφή. Για το Request της σύνδεσης του χρήστη στο Pylon Connectivity API (elogin), χρειάζονται τα παρακάτω πεδία :
- string apicode : Το αναγνωριστικό του Pylon API Template [Κωδικός Σεναρίου].
- String applicationname: To αναγνωριστικό της έκδοσης του Pylon [Hercules.yourApplicationName].
- string databasealias : Το αναγνωριστικό της βάσης δεδομένων του Pylon.
- string username : Το αναγνωριστικό του χρήστη που έχει οριστεί στο Pylon API Template.
- string password : O κωδικός του χρήστη που έχει οριστεί στο Pylon API Template.
Εφόσον η σύνδεση είναι επιτυχημένη, τότε το Pylon API θα απαντήσει με τα πεδία :
- datetime created : Η ημερομηνία και ώρα σύνδεσης του χρήστη.
- datetime expired : Η ημερομηνία και ώρα λήξης της σύνδεσης του χρήστη.
- string username : Το αναγνωριστικό του χρήστη.
- string cookie : Το αναγνωριστικό του χρήστη μετά τη σύνδεση το οποίο χρησιμοποιείται σε οποιαδήποτε από τις επόμενες επικοινωνίες, μέχρι την λήξη.
Για κλήση άντλησης δεδομένων από το Pylon (getdata), πρέπει να συμπεριλάβατε στο Request σας τα παρακάτω πεδία :
- string cookie : Το αναγνωριστικό της σύνδεσης του χρήστη στο Pylon Connectivity API.
- string apicode : Το αναγνωριστικό του Pylon API Template.
- String entitycode : Το αναγνωριστικό του τύπου των δεδομένων προς άντληση όπως αυτό έχει παραμετροποιηθεί στο Pylon API Template, δηλαδή ο κωδικός του Script.
- int packagenumber : Το αναγνωριστικό του τύπου των δεδομένων προς άντληση όπως αυτό έχει παραμετροποιηθεί στο Pylon API Template.
- int packagesize : Το μέγεθος του πακέτου δεδομένων προς άντληση.
- Dictionary <string, object> extras : Συμπληρώνονται στην μορφή key – value το όνομα του πεδίου και η τιμή του πεδίου που αφορούν σε οποιεσδήποτε επιπλέον πληροφορίες έχουν τυχόν παραμετροποιηθεί από τον διαχειριστή του Pylon για το API Template.
Εφόσον το Request ήταν επιτυχημένο, τότε το Pylon API θα απαντήσει με τα δεδομένα τα οποία ζητήσατε, διαφορετικά θα σας εμφανίσει ενημερωτικό κατάλληλο μήνυμα.
Για κλήση αποθήκευσης δεδομένων στο Pylon (postdata), πρέπει να συμπεριλάβετε στο Request σας, τα παρακάτω πεδία :
- string cookie : Το αναγνωριστικό της σύνδεσης του χρήστη στο Pylon Connectivity API.
- string apicode : Το αναγνωριστικό του Pylon API Template.
- string entitycode : Το αναγνωριστικό του τύπου των δεδομένων προς άντληση όπως αυτό έχει παραμετροποιηθεί στο Pylon API Template, δηλαδή ο κωδικός του Script.
- string data : Json serialized object που περιέχει τα δεδομένα που θα αποθηκευτούν στο Pylon όπως αυτά έχουν παραμετροποιηθεί από τον διαχειριστή του Pylon για το API Template. Η αποθήκευση της παραγγελίας θα μπορούσε να είναι της μορφής :
{
“CstmTIN” : Το ΑΦΜ του Πελάτη, το οποίο χρησιμοποιείται για την εύρεση του Πελάτη στο Pylon.
“SeriesCode” : Ο κωδικός της Σειράς Παραστατικού.
“CsbrName” : Το υποκατάστημα του Πελάτη.
“PmmtName” : Ο τρόπος Πληρωμής.
“Lines” : Οι γραμμές του Παραστατικού.
[
{
“CenlItemCode” : Ο κωδικός του είδους.
“CenlPrice” : Η τιμή του είδους.
“CenlAMeasurementQty ” : Η ποσότητα της 1ης μονάδας μέτρησης του συγκεκριμένου είδους.
}
]
}
Για επιπλέον γραμμές στο παραστατικό θα πρέπει να επαναλάβετε τις αγκύλες βάζοντας το σημείο στίξης κόμμα (‘,’) μεταξύ τους.
Σύμφωνα με τα παραπάνω η προκαθορισμένη αναζήτηση του Πελάτη στα Script γίνεται με βάση το ΑΦΜ ή το μοναδικό ID του Πελάτη, όμως μπορείτε να επεξεργαστείτε το ήδη υπάρχων script ή να δημιουργήσετε νέο, και να χρησιμοποιήσετε κάποια άλλη παράμετρο αναζήτησης. Παρόμοια μπορείτε να ενεργήσετε και για άλλες λειτουργικότητες που σας ενδιαφέρουν και θέλετε να υλοποιήσετε.
Επίσης, έχετε τη δυνατότητα να χρησιμοποιήσετε το εργαλείο API Tester, για να δοκιμάσετε τα Queries και τα Scripts, αναφορικά με το Pylon.
Στην οντότητα ‘Configuration’ στα παρακάτω πεδία πρέπει να συμπληρώστε τα εξής :
- ‘Server Address’ : Την διεύθυνση που έχετε δηλώσει στο Connectivity API στον ‘Pylon Configurator’ στο ‘Daemons’.
- ‘Application’ : To αναγνωριστικό του προϊόν της εγκατάστασης.
- ‘API Code’ : Τον κωδικό του API σεναρίου.
- ‘Package Size’ : Το μέγεθος του πακέτου.
- ‘DB Alias’ : Το alias της βάσης δεδομένων της εγκατάστασης
- ‘Username’ : Το όνομα χρήστη που δηλώσατε στο API Template.
- ‘Password’ : Τον κωδικό που δηλώσατε στο API Template.
Στην οντότητα ‘Execution’ συμπληρώνεται τον τύπο της ενέργειας, τον κωδικό του Script και τον αριθμό του πακέτου.
- ‘Service Type’ : ‘GetData’ για να πάρετε δεδομένα από την εφαρμογή και ‘PostData’ για να στείλετε δεδομένα στην εφαρμογή.
- ‘Service’ : Τον κωδικό του Script που θέλετε να εκτελέσετε, το οποίο βρίσκεται στην καρτέλα ‘Scripts’ στο API Template.
- ‘Package #’ : Τον αριθμό του πακέτου.
Στην τελευταία στήλη παρατηρείτε ότι μπορείτε να δηλώσετε παραμέτρους, όπου οι παράμετροι έχουν δηλωθεί στα ‘Queries’ και στα ‘Scripts’ του API Template. Συμπληρώνοντας όλα τα απαραίτητα πεδία και επιλέγοντας ‘Execute’, εμφανίζονται τα αποτελέσματα της κλήσης, δηλαδή το JSON response ανάλογα με το ‘Service’ που καλούμε.
Στην περίπτωση της εκτέλεσης ‘PostData’ ως ‘Service Type’, εμφανίζεται μία επιπλέον καρτέλα στην τελευταία στήλη δίπλα στην καρτέλα ‘Parameters’, με όνομα ‘Import Buffer’, στο οποίο δημιουργείται αυτόματα ένα sample με τα δεδομένα της Παραγγελίας προς Αποστολή. Συμπληρώνοντας ως ‘Service’ τον κωδικό του Script για την αποστολή των παραγγελιών, όπου το προκαθορισμένο Script είναι το ‘SalesOrders’, και αλλάζοντας τα δεδομένα σύμφωνα με την δική σας παραμετροποίηση, δημιουργείτε το κατάλληλο ‘Import Buffer’, ώστε να στείλετε την παραγγελία στην εφαρμογή Pylon.
Αφού δημιουργήσετε το κατάλληλο JSON ‘Import Buffer’ σύμφωνα με την δική σας παραμετροποίηση, επιλέγετε ‘Execute’ και μπορείτε να δείτε το JSON Response της συγκεκριμένης ενέργειας.
