• Εισαγωγή
• Γενικοί Κωδικοί σφάλματος API
• Οδηγίες Bearer Token - Ταυτοποίηση Χρήστη του Rest API
• Web App Module Courier (courier00)
  • Αλλαγή κατάστασης Voucher
  • Καταστάσεις Εργασιών
  • Λίστα Δρομολογίων Οδηγού
  • Vouchers

Οι τύποι των δεδομένων του REST Service είναι:

1. String: Συμβολοσειρά
2. Number: Όλες οι πιθανές αριθμητικές μεταβλητές
3. Boolean: Ακέραιος αριθμός. Οι τιμές που μπορεί να πάρει είναι 0 για το false και 1 για το true
4. Date: Η ημερομηνία. Η ημερομηνία πρέπει να είναι της μορφής "Y-m-d"

Mπόρειτε να κατεβασετε το collation για το Postman με όλα τα end-points του service απο εδώ

Τα request παραλαβής (GET) των δεδομένων έχουν τις εξής παραμέτρους:

1. recperpage: Το πλήθος των δεδομένων που θα γίνουν παραλαβή
2. page: Η σελίδα των δεδομένων.
3. order_array: Τα πεδία με το οποία θα γίνει η ταξινόμηση των αποτελεσμάτων του get.
   π.χ. /api/crm001/d00?order_array[p19]=DESC&order_array[nr01]=ACS
4. filter: Οι συνθήκες επιλογής δεδομένων εμφάνισης.
   π.χ. /api/crm001/d00?filter[or][0][p19][starts]=ψ&filter[or][1][p19][equals]=Φύλακας 1  - Οδηγος&filter[and][0][nr01][lt]=3000033
   Εάν Θέλω να μου φέρει από τους συναλλασσόμενους όσους ο διακριτικός τους τίτλος ξεκινά από "ψ" ή είναι ίσος με "Φύλακας 1  - Οδηγος" και το Μ.Κ. είναι μικρότερο από 3000033.
   Αναλυτικά.
   Στο filter τα όρισμα είναι:
1. 'or' ή 'and' όπου ορίζεται η συνθήκη σύνδεσης των υποσυνθηκών.
2. Ένας αύξοντας αριθμός που χαρακτηρίζει την υποσυνθήκη.
3. Το πεδίο στο οποίο θα υπάρχει ο περιορισμός.
4. Η συνθήκη του περιορισμού*.
5. Η τιμή σύγκρισης με το πεδίο

* Οι συνθήκες περιορισμών είναι:

* Εκτός από τα πεδία του response μπορούμε να χρησιμοποιήσουμε και το πεδιο remdatetime που περιεχει το concat(remdate , ' ' , remtime) ετσι μπορουμε να αναζητησουμε τα record που ειναι μεγαλυτερα απο μια ημερομηνία και ώρα.
π.χ. ?filter[and][0][remdatetime][gte]=2021-05-03 19:20:00

Τα request διαγραφής δεδομένων (DELETE) θα πρέπει πάντα να έχουν συμπληρωμένο το {id} που θα διαγραφεί

Τα request δημιουργίας νέων εγγραφών (POST) εάν έχουν συμπληρωμένο το {id} και βρουν την εγγραφή την κάνουν update

Τα request διαχείρισης εγγραφών (PUT) θα πρέπει πάντα να έχουν συμπληρωμένο το {id} το οποίο θα διαχειριστούν

Σε όλα τα (GET) μπορούμε να συμπληρώσουμε μετά τα endpoints μπορούμε να συμπληρώσουμε.

/all
Mε το /all μας φέρνει όλα τα δεδομένα και σε όσα πεδία συνδέονται με άλλο πινάκα εκτός από το πεδίο του κωδικού μας φέρνει και την περιγραφή από το δεύτερο πίνακα με την λογική v_selectbox_{όνομα πεδίου}

/gridall
Η ίδια λογική με το /all αλλα μας φέρνει μόνο τα πεδία που έχουν οριστεί ότι εμφανίζονται στις λίστες δεδομένων.

/{id}
Με το /{id} μας  φέρνει την εγγραφή με μοναδικό κωδικό {id}

Η ταυτοποίηση του χρήστη για τις κλήσεις του Rest API γίνεται με μέσω του Bearer token (ή access_token), το οποίο πρέπει να συμπεριλαμβάνεται στο Authorization header των request (--header 'Authorization: …').
Το access_token παραμένει ενεργό για περιορισμένο χρονικό διάστημα.

Παρακάτω παρουσιάζεται συνοπτικά η ροή που θα ακολουθήσετε:

a.Δημιουργία access token
Αρχικά καλείτε το initiate_authentication. Στην απάντηση που θα λάβετε περιέχεται ένα url το οποίο ανοίγετε και κάνετε login στο Pegasus Web App για να ταυτοποιηθεί ο χρήστης. Όταν ολοκληρωθεί το login, γίνεται redirect του browser στο redirect url που είχατε ορίσει στο αρχικό initiate_authentication με παράμετρο GET - το access_code.

Τέλος καλείτε το endpoint get_access_token χρησιμοποιώντας το access_code. Ως αποτέλεσμα θα λάβετε ένα access_token μαζί με ένα refresh_token.

b.Ανανέωση token
Όταν λήξει το access token θα λάβετε error 419 στο http_status σε οποιοδήποτε request καλέσετε με το ληγμένο access_token. Σε αυτή την περίπτωση εκτελείτε το endpoint refresh_token χρησιμοποιώντας το refresh_token που λάβατε σαν response από το get_access_token. Ως αποτέλεσμα θα λάβετε ένα νέο access token.

c.Διαχείριση Tokens μέσω του Pegasus Web App
Από το Pegasus Web App και στη διαδρομή [Toolbox->Εργαλεία Παραμετροποίησης->Παραμετροποίηση Rest Service->App IDs] διαχειρίζεστε τα Tokens που έχουν δημιουργηθεί. Μπορείτε να απενεργοποιήσετε ένα token ή να ορίσετε τα δικαιώματα για τις ενέργειες που ο χρήστης μπορεί να εκτελέσει. Για τη διαχείριση των δικαιωμάτων δεν είναι απαραίτητη η πρόσβαση στο Web App, μπορείτε να τα ορίσετε και κατά την Παραγωγή προσωρινού κωδικού(/initiate_authentication) στα πεδία pegapi01_02 και pegapi01_q10.