Differences

This shows you the differences between two versions of the page.

--- el:developers:mobile_api [2022/11/16 10:22] – admin
+++ el:developers:mobile_api [2023/04/12 11:58] (current) – admin
@@ Line 4: / Line 4: @@
 Τα βασικά scripts είναι
-  * ''openeclass_base/modules/mobile/mcourses.php'' Επιστρέφει τα μαθήματα της πλατφόρμας σε μορφή xml (αντίστοιχο με το opencourses.php).
+  * ''openeclass_base/modules/mobile/mcourses.php'' Επιστρέφει τα μαθήματα της πλατφόρμας σε μορφή xml (αντίστοιχο με το ''opencourses.php'').
-  * ''openeclass_base/modules/mobile/mcourses.php?registered''. Αν ο χρήστης έχει κάνει login, επιστρέφει μόνο τα μαθήματα στα οποία είναι γραμμένος, αν δεν έχει κάνει login, επιστρέφει την ίδια ακριβώς λίστα όπως το από πάνω (opencourses).
+  * ''openeclass_base/modules/mobile/mcourses.php?registered''. Αν ο χρήστης έχει κάνει login, επιστρέφει μόνο τα μαθήματα στα οποία είναι γραμμένος, αν δεν έχει κάνει login, επιστρέφει την ίδια ακριβώς λίστα όπως προηγουμένως.
   * ''openeclass_base/modules/mobile/mtools.php?course=CODE''. Επιστρέφει τα εργαλεία μαθήματος για συγκεκριμένο μάθημα (δηλαδή το αριστερό μενού μαθήματος). Λειτουργεί με τον ίδιο τρόπο που λειτουργεί και το κανονικό μενού, δηλαδή αν ο χρήστης είναι καθηγητής θα του φέρει 2 επιπλέον groups εργαλείων (τα ανενεργά και τα διαχείρισης).
-  * ''openeclass_base/modules/mobile/mlogin.php?token=TOKEN''. Ως είσοδο εδώ δέχεται το php session id (ό,τι πληροφορία έχει και το cookie δηλαδή). Αν βρεθεί το συγκεκριμένο session, τότε επιστρέφει ''plain text OK'', αλλιώς ''plain text EXPIRED''.
+  * ''openeclass_base/modules/mobile/mlogin.php?token=TOKEN''. Ως είσοδο εδώ δέχεται το php session id (ό,τι πληροφορία έχει και το cookie δηλαδή). Αν βρεθεί το συγκεκριμένο session, τότε επιστρέφει σε plain text ''OK'', αλλιώς σε plain text ''EXPIRED''. Στην περίπτωση επιτυχημένου login επιστρέφει plain text το TOKEN που χρησιμοποιείται στο από πάνω παράδειγμα.
-Στην περίπτωση επιτυχημένου login επιστρέφει plain text το TOKEN που χρησιμοποιείται στο από πάνω παράδειγμα.
-''openeclass_base/modules/mobile/mlogin.php?uname=UNAME&pass=PASS''
+  * ''openeclass_base/modules/mobile/mlogin.php?uname=UNAME&pass=PASS''. Σε περίπτωση επιτυχημένου login επιστρέφει XML περιεχόμενο ''SUCCESS'' πετυχημένου login. Σε περίπτωση αποτυχίας επιστρέφει σε μορφή plain text ένα από τα παρακάτω:
+       * ''FAILED'' ως γενική περίπτωση αποτυχίας
+       * ''NOTENABLED'' όταν δεν είναι ενεργοποιημένο το api στα configs του eclass admin
+       * ''USERNOTACTIVE'' όταν ο λογαριασμός του χρήστη στο eclass έχει λήξει
+       * ''OK'' σε περίπτωση επιτυχίας χωρίς XML output (πχ στο logout request)
-Σε περίπτωση επιτυχημένου login επιστρέφει XML περιεχόμενο
+  * ''openeclass_base/modules/mobile/mlogin.php?logout''. Καταστροφή του session και logout.
-@SUCCESS@ πετυχημένου login
+  * ''openeclass_base@/modules/mobile/midentity.php''. Πληροφορίες για την εγκατεστημένη πλατφόρμα χωρίς authentication. Παράδειγμα απάντησης
+           <code>
+           <?xml version="1.0" encoding="utf-8"?>
+             <identity>
+               <institute name="Ακαδημαϊκό Διαδίκτυο GUNet" url="http://www.gunet.gr/"/>
+               <platform name="Open eClass 3.x" version="3.12-dev"/>
+               <administrator name="Διαχειριστής Πλατφόρμας"/>
+             </identity>
+           </code>
-Σε περίπτωση αποτυχίας επιστρέφει σε μορφή plain text
+Όλα τα παραπάνω δέχονται τα arguments είτε με GET είτε με POST.
-@FAILED@ ως γενική περίπτωση αποτυχίας
-@NOTENABLED@ όταν δεν είναι ενεργοποιημένο το api στα configs του eclass admin
-@USERNOTACTIVE@ όταν ο λογαριασμός του χρήστη στο eclass έχει λήξει
-@OK@ σε περίπτωση επιτυχίας χωρίς XML output (πχ στο logout request)
-_openeclass_base_ @/modules/mobile/mlogin.php?logout@
+----
-καταστροφή του session και logout.
-Πληροφορίες για την εγκατεστημένη πλατφόρμα, (χωρίς authentication):
+== Παράδειγμα χρήσης μέσω Bash Script (προϋποθέτει την ύπαρξη της ''curl'') ==
- _openeclass_base_ @/modules/mobile/midentity.php@
-Παράδειγμα απάντησης
-<pre>
-<?xml version="1.0" encoding="utf-8"?>
-<identity>
-  <institute name="Ακαδημαϊκό Διαδίκτυο GUNet" url="http://www.gunet.gr/"/>
-  <platform name="Open eClass 3.x" version="3.6-dev"/>
-  <administrator name="Διαχειριστής Πλατφόρμας"/>
-</identity>
-</pre>
-Όλα τα παραπάνω δέχονται τα arguments είτε με GET είτε με POST.
+<code>
-h3. Παράδειγμα χρήσης μέσω Bash Script (προϋποθέτει την ύπαρξη της _curl_):
-<pre>
 #!/bin/bash
@@ Line 60: / Line 52: @@
 # logout from eclass
 curl -d "token=$TOKEN" "$ECLASSURL/modules/mobile/mlogin.php?logout"
-</pre>
+</code>
-h3. Χρήση μέσω C#
+----
-Αν είστε  χρήστης της C# τότε μπορείτε να χρησιμοποιήσετε τον παρακάτω mobile API client:
+=== Διαγράμματα του mobile API ===
-https://github.com/amoraitis/EclassMobileApi
-Μπορείτε να το εγκαταστήσετε μέσω NuGet  (https://www.nuget.org/packages/EclassApi)
+{{:el:developers:mobileapi.png?600|}}
+{{:el:developers:mobileapi-return-codes.png?600|}}
+----
+=== Χρήση μέσω C# ===
+Αν είστε  χρήστης της C# τότε μπορείτε να χρησιμοποιήσετε τον παρακάτω mobile API client:
+[[https://github.com/amoraitis/EclassMobileApi]]
-h3. Τα παραπάνω παρουσιάζονται στα ακόλουθα σχήματα:
+Μπορείτε να το εγκαταστήσετε μέσω NuGet  ([[https://www.nuget.org/packages/EclassApi]])