Τεκμηρίωση API

Αυτή είναι η τεκμηρίωση για τα διαθέσιμα τελικά σημεία API, τα οποία είναι χτισμένα γύρω από την αρχιτεκτονική REST. Όλα τα τελικά σημεία API θα επιστρέψουν μια απόκριση JSON με τους τυπικούς κώδικες απόκρισης HTTP και χρειάζονται Έλεγχος ταυτότητας φορέα μέσω κλειδιού API.

Αποκτήστε το δικό σας κλειδί API

Βασική διεύθυνση URL

Αυθεντικοποίηση

Όλα τα τελικά σημεία του API απαιτούν ένα κλειδί API που αποστέλλεται με τη μέθοδο Αυθεντικοποίηση φορέα.

Authorization: Bearer {api_key}

Παράδειγμα

curl --request GET \
--url 'https://staging.qrity.gr/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Σφάλματα

Το API μας χρησιμοποιεί τυπικούς κωδικούς κατάστασης HTTP για να δηλώσει την επιτυχία ή την αποτυχία ενός αιτήματος.

Παράδειγμα

{
    "errors": [
        {
            "title": "\u0394\u03b5\u03bd \u03ad\u03c7\u03b5\u03c4\u03b5 \u03c0\u03c1\u03cc\u03c3\u03b2\u03b1\u03c3\u03b7 \u03c3\u03c4\u03bf API.",
            "status": 401
        }
    ]
}

Κωδικοί κατάστασης

200 Το αίτημα ολοκληρώθηκε με επιτυχία

400 Λανθασμένο αίτημα - Απαιτούμενες παράμετροι λείπουν ή είναι μη έγκυρες

401 Μη εξουσιοδοτημένο - Το κλειδί API λείπει ή είναι μη έγκυρο

404 Ο ζητούμενος πόρος δεν βρέθηκε

429 Πάρα πολλά αιτήματα - Ξεπεράστηκε το όριο ρυθμού

500 Εσωτερικό σφάλμα διακομιστή - αυτό σημαίνει ότι υπάρχει πρόβλημα από την πλευρά μας

Όλα τα αποτελέσματα των endpoints του API λειτουργούν με τη ζώνη ώρας UTC εκτός αν ορίζεται διαφορετικά.

Χρήστης

Κώδικες QR

Barcodes

Σύνδεσμοι

Στατιστικά συνδέσμων

Έργα

Αρχεία καταγραφής λογαριασμού