Τεκμηρίωση του Lingara API

Σφάλματα

402application/json

Η κλήση ενός πελάτη με χρέωση βάσει χρήσης απορρίφθηκε πριν καταναλώσει οτιδήποτε. spend_cap_reached: ο πελάτης ή ο λογαριασμός του έφτασε το μηνιαίο όριο δαπανών του· αυξήστε το όριο στη σελίδα Ενσωματώσεις. metered_billing_inactive: η χρέωση βάσει χρήσης δεν είναι ενεργή για αυτόν τον λογαριασμό· ρυθμίστε την ή ενημερώστε τον τρόπο πληρωμής στη σελίδα Ενσωματώσεις.

410application/json

Η έκδοση API με την οποία απαντάται αυτό το αίτημα έχει καταργηθεί. Στείλτε μια υποστηριζόμενη έκδοση στο Lingara-Version ή συνδέστε τον πελάτη με άλλη έκδοση.

4XXapplication/json

Το αίτημα απορρίφθηκε. Το code λέει γιατί και το error το εξηγεί με λόγια.

503application/json · text/plain

Η υπηρεσία δεν είναι προσωρινά διαθέσιμη· δοκιμάστε ξανά μετά τον αριθμό δευτερολέπτων στο Retry-After. Κατά τη συντήρηση, το σώμα είναι απλό κείμενο αντί για τον φάκελο σφάλματος.

5XXapplication/json

Το αίτημα απορρίφθηκε. Το code λέει γιατί και το error το εξηγεί με λόγια.

codestringυποχρεωτικό

Γιατί απορρίφθηκε το αίτημα, ως σταθερός κωδικός για διακλάδωση: για παράδειγμα insufficient_scope (403), rate_limited (429) και, για πελάτη με χρέωση βάσει χρήσης, spend_cap_reached (402) και metered_billing_inactive (402).

errorstringυποχρεωτικό

Λεξιλόγιο

Δημιουργία λιστών λεξιλογίου στο επίπεδο του μαθητή.

• Δημιουργία λίστας λεξιλογίου POST /v1/vocab/stream

Σχέδια μαθήματος

Δημιουργία σχεδίων μαθήματος, ανάγνωσή τους και επανασύνδεση σε ένα που δημιουργείται ακόμη.

• Δημιουργία σχεδίου μαθήματος POST /v1/lesson-plans
• Λήψη σχεδίου μαθήματος GET /v1/lesson-plans/{id}
• Επανασύνδεση σε σχέδιο μαθήματος GET /v1/lesson-plans/{id}/stream

Καθηγητής

Συνομιλία με τον καθηγητή γλώσσας, έναν γύρο τη φορά.

• Αποστολή γύρου στον καθηγητή POST /v1/tutor/message

Συμβάντα

Διαβάστε τα συμβάντα του λογαριασμού σας, σελίδα προς σελίδα ή ως ροή.

• Λίστα συμβάντων GET /v1/events
• Αποστολή συμβάντος POST /v1/events
• Ροή συμβάντων GET /v1/events/stream

Λογαριασμός

Δείτε πόσο από το όριο χρήσης σας απομένει.

• Λήψη του υπολοίπου του ορίου χρήσης σας GET /v1/usage

Αναφορά

Αυτό το έγγραφο, σε μορφή αναγνώσιμη από μηχανή.

• Λήψη αυτού του εγγράφου GET /v1/openapi.json
• Λήψη του εγγράφου συμβάντων GET /v1/asyncapi.json
• Λίστα εκδόσεων API GET /v1/versions
• Λήψη μιας έκδοσης API GET /v1/versions/{id}

Κατάλογος συμβάντων

Το Lingara καταγράφει ως συμβάντα ό,τι συμβαίνει στα σχέδια μαθήματος και στη χρήση του λογαριασμού σας, και δέχεται συμβάντα από το παιχνίδι ή την εφαρμογή σας. Κάθε συμβάν, όποιον δρόμο κι αν ακολουθεί, έχει τον ίδιο φάκελο, και ο κατάλογος συμβάντων τα παραθέτει όλα. Webhooks και συμβάντα

• Lingara → εσείς lesson_plan.ready
• Lingara → εσείς lesson_plan.failed
• Lingara → εσείς usage.threshold_reached
• Lingara → εσείς webhook.test
• Lingara → εσείς app.installed
• Lingara → εσείς app.uninstalled

• Εσείς → Lingara world.context_changed
• Εσείς → Lingara world.practice_requested