Το παρακάτω παράδειγμα περιγράφει τον τρόπο με τον οποίο γίνεται κλήση σε ένα API για τη δημιουργία αναφοράς. Το API υποστηρίζει αιτήματα τύπου GET και απαιτεί συγκεκριμένες παραμέτρους για τη δημιουργία αναφοράς. Η κλήση γίνεται σε συγκεκριμένο URL, το οποίο εξαρτάται από τον διακομιστή (server) στον οποίο φιλοξενείται ο πελάτης.
Σημείωση για το URL
Το URL της κλήσης στο API, όπως για παράδειγμα το rdp103.sbzsystems.com, εξαρτάται από τον διακομιστή που φιλοξενεί την εφαρμογή του πελάτη. Επομένως, το συγκεκριμένο τμήμα του URL θα ποικίλει ανάλογα με το περιβάλλον όπου βρίσκεται ο πελάτης. Ο πελάτης θα πρέπει να χρησιμοποιήσει το κατάλληλο URL που έχει εκχωρηθεί στον δικό του server για να διασφαλιστεί η σωστή λειτουργία της κλήσης.
Μέθοδος Κλήσης
Η κλήση στο API γίνεται μέσω της μεθόδου GET. Η μορφή της κλήσης απαιτεί την παροχή συγκεκριμένων παραμέτρων στην ίδια τη διεύθυνση URL, οι οποίες καθορίζουν τα δεδομένα που θα ανακτηθούν.
URL Κλήσης
Η κλήση γίνεται σε ένα URL της μορφής:
|
1 |
https://[server του πελάτη]/apps/createreport.aspx |
Όπου το [server του πελάτη] αντιπροσωπεύει το όνομα του διακομιστή που χρησιμοποιείται για την εφαρμογή του πελάτη.
Παράμετροι
Οι παράμετροι που προστίθενται στο URL είναι οι εξής:
from: Καθορίζει την ημερομηνία και ώρα έναρξης των δεδομένων που θα ανακτηθούν, σε μορφήYYYYMMDDHHMMSS. Για παράδειγμα,from=20240101000000αναφέρεται στην 1η Ιανουαρίου 2024, ώρα 00:00:00.to: Καθορίζει την ημερομηνία και ώρα λήξης των δεδομένων, επίσης σε μορφήYYYYMMDDHHMMSS. Για παράδειγμα,to=20240901000000αναφέρεται στην 1η Σεπτεμβρίου 2024, ώρα 00:00:00.date: Καθορίζει μία ημερομηνία δεδομένων, σε μορφήYYYY-MM-DD. Για παράδειγμα,date=2024-09-01αναφέρεται σε όλη την 1η Σεπτεμβρίου 2024.user: Το όνομα χρήστη windows που εκτελείται η EMDI. Για παράδειγμα,user=testuser.q: Ο τίτλος της αναφοράς, για παράδειγμα,q=00.orders.key: Ένα κλειδί ασφαλείας που απαιτείται για την πρόσβαση στο API. Το κλειδί αυτό ορίζεται στις ρυθμίσεις της EMDI, επικοινωνία/συντήρηση, επικοινωνία μέσω http, κωδικός.
format: Η μορφή στην οποία θα επιστραφούν τα δεδομένα. Στο συγκεκριμένο παράδειγμα, η τιμή είναιjson, πράγμα που σημαίνει ότι τα δεδομένα θα επιστραφούν σε μορφή JSON. Να σημειωθεί ότι θα πρέπει και η αναφορά να έχει σχεδιαστεί αντίστοιχα ώστε να είναι έγκυρο το αποτέλεσμα.
Παράδειγμα Κλήσης
Η πλήρης κλήση σε αυτό το API με τις παραπάνω παραμέτρους μπορεί να έχει την εξής μορφή:
|
1 |
https://[server του πελάτη]/apps/createreport.aspx?from=20240101000000&to=20240901000000&user=testuser&q=00.orders&key=123&format=json |
Αυτό το URL περιλαμβάνει όλες τις απαραίτητες πληροφορίες για την δημιουργία της αναφοράς για το χρονικό διάστημα από 1 Ιανουαρίου 2024 έως 1 Σεπτεμβρίου 2024, για τον χρήστη “testuser”, με αναφορά στις παραγγελίες και επιστροφή των δεδομένων σε μορφή JSON.
Απάντηση
Το API θα επιστρέψει μια αναφορά με τη μορφή που ζητήθηκε, π.χ. σε JSON, η οποία μπορεί να αναλυθεί και να χρησιμοποιηθεί από το σύστημα ή την εφαρμογή.
Παράδειγμα Κώδικα
Ο παρακάτω κώδικας παρουσιάζει πώς μπορεί να γίνει με PHP η κλήση στο API και η διαχείριση της απάντησης:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://[server του πελάτη]/apps/createreport.aspx?from=20240101000000&to=20240901000000&user=testuser&q=00.orders&key=123&format=json', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'GET', )); $response = curl_exec($curl); curl_close($curl); echo $response; |
Σημείωση: Η αντικατάσταση του [server του πελάτη] με το σωστό URL του διακομιστή του πελάτη είναι απαραίτητη για την ορθή λειτουργία του API.
