Τεκμηρίωση REST API

Εισαγωγή

Το API του sansimera.gr ακολουθεί τη λογική του REST. Για τη χρήση των παρεχόμενων λειτουργιών απαιτείται η αποστολή κατάλληλα διαμορφωμένων HTTP αιτημάτων, ενώ οι απαντήσεις επιστρέφονται σε μορφή JSON.

Τα παραδείγματα που παρουσιάζονται στην τεκμηρίωση μπορούν να χρησιμοποιηθούν “ως έχουν” στον κώδικά σας ή στο τερματικό σας εάν χρησιμοποιείτε curl. Απλώς αντικαταστήστε το api token με το δικό σας.

Άδεια Χρήσης – Ταυτοποίηση

Για να αρχίσετε να χρησιμοποιείται το API, θα πρέπει να διαθέτετε μία Άδεια Χρήσης (API Licence) κι ένα API Token. Πληροφορίες για την απόκτηση Άδειας Χρήσης μπορείτε να βρείτε εδώ.

Εφόσον διαθέτετε ήδη Άδεια Χρήσης, για να δημιουργήσετε ένα API Token μεταβείτε στο λογαριασμό σας, επιλέξτε την καρτέλα “Ρυθμίσεις Ασφαλείας” και πατήστε το κουμπί “Έκδοση API Token”. Μην δημοσιοποιείτε και μην μοιράζεστε ποτέ με τρίτους το API Token, διότι ισοδυναμεί με το όνομα χρήστη και τον κωδικό πρόσβασης στο λογαριασμό σας. Κανένα αίτημα δεν θα επιστρέψει προσωπικά σας δεδομένα, ωστόσο είστε υπεύθυνοι για οποιαδήποτε κλήση γίνει με αυτό. Μπορείτε να ζητήσετε την επανέκδοσή του οποιαδήποτε στιγμή, ακολουθώντας την ίδια διαδικασία.

Κάθε αίτημά σας προς το σύστημα θα πρέπει να περιέχει το API Token, όπως φαίνεται στο παρακάτω παράδειγμα:

curl -X GET https://api.sansimera.gr/calendar
    -H "Accept: application/json"
    -H "Authorization: Bearer a4GsDBSwJv74Xbcyadjca2iVkOx28zks3JRQhpWEYez8JQaqJ"
    
$response = $client->request('GET', 'https://api.sansimera.gr/calendar', [
    'headers' => [
        'Accept' => 'application/json'
    ],
    'form_params' => [
        'api_token' => 'a4GsDBSwJv74Xbcyadjca2iVkOx28zks3JRQhpWEYez8JQaqJ'
    ]
]);