Pegasus WEB App REST API

REST Service

Προβολή όλων των API

Περιεχόμενο

Εισαγωγή
Γενικοί Κωδικοί σφάλματος API
Οδηγίες Bearer Token - Ταυτοποίηση Χρήστη του Rest API
Web App Module REST Service (pegapi)

Εισαγωγή

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

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

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

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

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

'or' ή 'and' όπου ορίζεται η συνθήκη σύνδεσης των υποσυνθηκών.
Ένας αύξοντας αριθμός που χαρακτηρίζει την υποσυνθήκη.
Το πεδίο στο οποίο θα υπάρχει ο περιορισμός.
Η συνθήκη του περιορισμού*.
Η τιμή σύγκρισης με το πεδίο

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

Όνομα	Περιγραφή	MySQL Operators - Functions	Παράδειγμα
equals	Ισότητα	=	filter[and][0][p19][equals]=Φύλακας 1
notequals	Διάφορο	!=	filter[and][0][p19][notequals]=Φύλακας 1
starts	Ξεκινάει από	LIKE 'a%'	filter[and][0][p19][starts]=Ψ
contains	Περιέχει	LIKE '%a%'	filter[and][0][p19][contains]=Ψ
ends	Τελειώνει	LIKE '%a'	filter[and][0][p19][ends]=Ψ
in	Εμπεριέχεται σε ένα σύνολο	IN()	filter[and][0][nr01][in][0]=3000027&filter[and][0][nr01][in][1]=3000028&filter[and][0][nr01][in][2]=3000029
notin	Δεν εμπεριέχεται σε ένα σύνολο	NOT IN()	filter[and][0][nr01][notin][0]=3000027&filter[and][0][nr01][notin][1]=3000028&filter[and][0][nr01][notin][2]=3000029
lt	Το πεδίο είναι μικρότερο από την τιμή	<	filter[and][0][nr01][lt]=3000030
lte	Το πεδίο είναι μικρότερο ή ίσο από την τιμή	<=	filter[and][0][nr01][lte]=3000030
gt	Το πεδίο είναι μεγαλύτερο από την τιμή	>	filter[and][0][nr01][gt]=3000030
gte	Το πεδίο είναι μεγαλύτερο ή ίσο από την τιμή	>=	filter[and][0][nr01][gte]=3000030

* Εκτός από τα πεδία του 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}

Γενικοί Κωδικοί σφάλματος API

Γενική μορφή ενός σφάλματος

{
	"code":Κωδικός Σφάλματος ,
	"data":{ 
		"error":{
			"title":"Τίτλος Σφάλματος",
			"detail":"Περιγραφή Σφάλματος"
		}
	}
}

Τίτλος	Πεδίο	Τύπος	Μέγεθος	Σφάλμα
Κωδικός Σφάλματος	code	String
Η περιγραφή του Σφάλματος	data	Array		Πίνακας με την περιγραφή του σφάλματος. {"error":{ "title":"Τίτλος Σφάλματος", "detail":"Περιγραφή Σφάλματος"}}

Method: GET, POST, DELETE, PUT

RESPONSE / HTTP response code: 400
Εάν το module το οποίο ορίζεται URL δεν υπάρχει
RESPONSE / HTTP response code: 400
Εάν η μέθοδος ή ο πίνακας που καλείται δεν υπάρχει κάτω από το module του URL
RESPONSE / HTTP response code: 400
Εάν η μέθοδος ή ο πίνακας που καλείται δεν έχει το δικαίωμα εκτέλεσης κάτω από το AppID της σύνδεσης
RESPONSE / HTTP response code: 401
Εάν η μέθοδος που καλείται χρειάζεται δικαιώματα και ο συνδεδεμένος χρήστης δεν τα έχει
RESPONSE / HTTP response code: 405
Όταν η μέθοδος του request δεν υποστηρίζεται από το Service

Method: GET

RESPONSE / HTTP response code: 209
Δεν βρέθηκαν εγγραφές στην εκτέλεση του get

Method: POST

RESPONSE / HTTP response code: 403
Πρόβλημα κατά την αποθήκευση
RESPONSE / HTTP response code: 500
Εκτέλεση μεθόδου POST όπου το Post Size είναι μεγαλύτερο από το όριο του server

Method: DELETE

RESPONSE / HTTP response code: 400
Δε βρέθηκε o πίνακας ή ο μοναδικός κωδικός
RESPONSE / HTTP response code: 403
Όταν οι περιορισμοί του πίνακα δεν επιτρέπουν τη διαγραφή της εγγραφής
RESPONSE / HTTP response code: 404
Δε βρέθηκε η εγγραφή στον πίνακα

Οδηγίες Bearer Token - Ταυτοποίηση Χρήστη του Rest API

Η ταυτοποίηση του χρήστη για τις κλήσεις του 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.

Web App Module REST Service (pegapi)

Παραγωγή προσωρινού κωδικού

Το initiate_authentication αποτελεί το πρώτο βήμα στη διαδικασία ταυτοποίησης για τη χρήση του Rest API. Όταν το endpoint κληθεί επιτυχώς, επιστρέφονται ένας προσωρινός κωδικός (init_code) και ένα url.

Μεταβένετε στο url του Pegasus Web App και συμπληρώνετε τα στοιχεία ενός έγκυρου χρήστη της εφαρμογής.

Μετά την επιτυχή επαλήθευση, πραγματοποιείται αυτόματα redirect στο Redirect url που είχε αποσταλεί στο request του initiate_authentication. Στο url αυτό περιλαμβάνεται πλέον και το access_code, το οποίο χρησιμοποιείται στο επόμενo βήμα - get_access_token.

Το init_code και το access_code λήγουν πέντε λεπτά μετά τη δημιουργία τους.

Method: POST: Τίτλος Πεδίο Τύπος Μέγεθος
Redirect URL redirect_url String 200 Το url που θα γίνει redirect μετά την επιτυχή σύνδεση του χρήστη στο Pegasus Web App. Υποχρεωτικά θα πρέπει να έχει τιμή.
Κωδικός Εφαρμογής appcode String 200
Πληροφορίες info String 200 Το πεδίο αυτό θα επιστραφεί στο τελικό redirect.
Ενέργειες pegapi01_02 JSON Array Τα Rest Actions (pegapi02) που έχει δικαίωμα να εκτελέσει ο χρήστη: [{"id":"το ΜΚ του Rest Action","actions":["ppost","pdelete","pput","pget"]}, ...]
π-Αναφορές pegapi01_q10 JSON Array Οι π-Αναφορές που έχει δικαίωμα να εκτελέσει ο χρήστης μέσω του Rest API: ["το ΜΚ της π-Αναφοράς","140000005000001",...]
Περιγραφή description String 200
Κωδικός Συσκευής device_id String 40
Γενικές Πληροφορίες Συσκευής device_info JSON Array Οι γενικές πληροφορίες της συσκευής. 'Οπως

Πάροχος

Τύπος Συσκευής

Serial Number

Αpp Version

IMSI

IMEI

Γλώσσα Δεδομένων lang String 2 Είναι η default γλώσσα για όλα τα επόμενα request. Πιθανές τιμες EN, GR, en, gr .

Παραγωγή access και refresh token

Το get_access_token είναι η διαδικασία μέσω της οποίας δημιουργούνται τα tokens που απαιτούνται για την πρόσβαση στο API. Καλείτε το endpoint ορίζοντας το access_code που λάβατε σαν παράμετρο GET - στο Redirect url που δώσατε στην initiate_authentication.

Method: POST: Τίτλος Πεδίο Τύπος Μέγεθος
Προσωρινός κωδικός access_code String

Ανανέωση Rest API Token

Όταν λήξει το access token λαμβάνετε error 419 στο http_status σε οποιοδήποτε request εκτελέσετε με το token αυτό.

Σε αυτή την περίπτωση καλείτε το refresh_token δίνοντας ως όρισμα το refresh_token που λάβατε στο response της get_access_token. Εάν το refresh_token είναι έγκυρο, το API επιστρέφει ένα νέο access_token.

Method: POST: Τίτλος Πεδίο Τύπος Μέγεθος
Token Ανανέωσης refresh_token String 100

Δομη Οθονών για την Mobile Εφαρμογή

Method: GET: Τίτλος Πεδίο Τύπος Μέγεθος
Μ.Κ. nr01 Νumeric 15
Όνομα πεδίου field_name String 30 To όνομα του πεδίου στο αντιστοιχο action
Module module String 50
Action action String 50
View Type view_type String 100 checkbox, combobox, datebox, htmltextarea, multi_selectbox, numberbox,radio, textarea, textbox, timefield, colorpicker
Grid Order grid_order Νumeric 15 Η διαδοχή στην εμφάνιση στις λίστες
Screen Order screen_order Νumeric 15 Η διαδοχή στην οθόνη/activity
Hidden in Grid grid_hidden Boolean 1 Αν θα ειναι κρυφό το πεδιο στις λίστες
Hidden in Screen screen_hidden Boolean 1 Αν θα είναι κρυφό το πεδιο στη οθόνη/ Αctivity
Readonly screen_readonly Boolean 1 Aν το πεδίο θα είναι μονο για αναγνωση στην οθόνη
Size fld_size Νumeric 2 Το μέγεθος του πεδίου (σε χαρακτήρες)
Decimals fld_dec Νumeric 2 Το πλήθος τον δεκαδικών
Τίτλος πεδίου field_title String 200 Επιστρέφει τον ελληνικό ή αγγλικό τίτλο ανάλογα με την γλώσσα που έχουμε συνδεθεί.
Selectbox Action selectbox_action String 100 To Action στο rest με τα δεδομένα
Selectbox Module selectbox_module String 50 Το module στο οποίο ανήκει ο πίνακας του selectbox
Selectbox Table selectbox_table String 50 Το όνομα του πίνακα στην βάση (πάντα υπάρχει όνομα με το ίδιο action) που αντλεί τα δεδομένα το selectbox (combobox, multi_selectbox)
Selectbox Value Field selectbox_valuefield String 50 Το πέδιο σύνδεσης στον πίνακα [Selectbox Table]
Selectbox Display Field selectbox_displayfield String 50 Το πέδιο που εμφανίζεται από τον πίνακα [Selectbox Table]
Selectbox Data List selectbox_ls_data Memo 10 Προεπιλεγμένες τιμές που μπορεί να εχει το select Box, επιστρέφει JSON με τις τιμές που μπορει να παρει το valueField,displayField

Παραλαβή Ενεργειών για mobile εφαρμογή

Το παραπανω endpoint επιστρέφει τη λίστα με τα actions που πρέπει κατεβασει κατά τον συχρονισμό η Mobile εφαρμογή.
Τα αποτελέσματα του Service επηρεάζονται από το mode της σύνδεσης του χρήστη.

Method: GET: Τίτλος Πεδίο Τύπος Μέγεθος
Action action String 100 To Action στο rest με τα δεδομένα

Συνδέσεις Πινάκων

Method: GET: Τίτλος Πεδίο Τύπος Μέγεθος
Πίνακας 1 table_1 String 50
Πεδιο 1 - Πίνακας 1 field1_0 String 50
Πεδιο 2 - Πίνακας 1 field1_1 String 50
Πεδιο 3 - Πίνακας 1 field1_2 String 50
Πίνακας 2 table_2 String 50
Πεδιο 1 - Πίνακας 2 field2_0 String 50
Πεδιο 3 - Πίνακας 2 field2_2 String 50
Πεδιο 2 - Πίνακας 2 field2_1 String 50

Παραλαβή Λεκτικών Εφαρμογής

Στην εκτέλεση αυτή της ενέργειας μπορείτε να χρησιμοποιήσετε τα φίλτρα ώστε να περιορίσετε την παραλαβή των λεκτικών ανά module

Method: GET: Τίτλος Πεδίο Τύπος Μέγεθος
Ο Μοναδικός Κωδικός του λεκτικού nr01 Νumeric 15
Το module όπου ανήκει το λεκτικό module String 50
Tag tag String 50 Ο κωδικός που χαρακτηρίζει το λεκτικό
Περιγραφή p01 String Η περιγραφή του λεκτικού ανάλογα με την γλώσσα του request

Παραλαβή Χρηστών

Method: GET: Τίτλος Πεδίο Τύπος Μέγεθος
Μ.Κ. nr01 Νumeric 15
Oνοματεπώνυμο p100 String 100
Εμφανίζεται στις λίστες επιλογών p300 Boolean 1
Μ.Κ. Συναλλασσομένου που αντιστοιχεί ο χρήστης p302 Νumeric 15
Όνομα Χρήστη p01 String 30
Προνόμιο Καταχωρήσεων Χρήστη p400 Νumeric 10
Βλέπει Εγγραφές με προνόμιο από p401 Νumeric 10
Βλέπει Εγγραφές με προνόμιο έως p402 Νumeric 10
Προεπιλεγμένο Προφίλ p95 Νumeric 15

Ενέργειες APP ID

Method: GET: Τίτλος Πεδίο Τύπος Μέγεθος
Το APP ID μπορεί να εκτελέσει POST στο Rest Action can_post Boolean 1
Το APP ID μπορεί να εκτελέσει DELETE στο Rest Action can_delete Boolean 1
Το APP ID μπορεί να εκτελέσει PUT στο Rest Action can_put Boolean 1
Το APP ID μπορεί να εκτελέσει GET στο Rest Action can_get Boolean 1
Μ.Κ. Είδους Rest Action (pegapi02) nr01 Νumeric 15
Module Rest Action module String 50
Rest Action URL action String 30
Περιγραφή Rest Action p01 String 100
Το Rest Action επιτρέπει POST ppost Boolean 1
Το Rest Action επιτρέπει DELETE pdelete Boolean 1
Το Rest Action επιτρέπει PUT pput Boolean 1
Το Rest Action επιτρέπει GET pget Boolean 1