Σύνδεση παίκτη με τον λογαριασμό του στο Lingara

Παράμετροι

Lingara-Versionheaderstringπροαιρετικό

Η έκδοση API με την οποία απαντάται αυτό το αίτημα. Χωρίς αυτήν, ένα token πρόσβασης παίρνει την έκδοση στην οποία είναι δεσμευμένος ο πελάτης του και ένα αίτημα χωρίς token παίρνει την τρέχουσα έκδοση. Η έκδοση που βρίσκεται ακόμη υπό ανάπτυξη είναι προσβάσιμη μόνο αν την ονομάσετε εδώ. Μια άγνωστη έκδοση απαντάται με 400 και κωδικό api_version_unknown. Το GET /v1/versions παραθέτει τις εκδόσεις.

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

Το player_ref με το οποίο εκδώσατε τα tokens του παίκτη, κωδικοποιημένο με ποσοστό: το guild/42 γίνεται guild%2F42.

Αποκρίσεις

200 Η σύνδεση του παίκτη

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

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

Το lgr_sub_ του λογαριασμού: αυτό που φέρουν από εδώ και πέρα τα συμβάντα αυτού του παίκτη.

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

Το lgr_sub_ του επισκέπτη: αυτό που κρατούν τα παλαιότερα συμβάντα του παίκτη. Δρομολογήστε και τα δύο στο ίδιο player_ref.

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

Πότε δημιουργήθηκε η σύνδεση. Σε απάντηση existing, η ώρα της πρώτης κλήσης.

scopesarray of stringυποχρεωτικό

Το μέγιστο που μπορεί τώρα να έχει ένα token για αυτόν τον παίκτη: ό,τι παραχώρησε ο λογαριασμός, από τα δικαιώματα που μπορεί να φέρει ένα token παίκτη.

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

Γραμμές που μετέφερε αυτή η κλήση στον λογαριασμό, ανά πίνακα. Εμφανίζονται μόνο πίνακες με μέτρηση.

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

Γραμμές που άφησε αυτή η κλήση στον επισκέπτη, ανά πίνακα: ένα πλάνο που ακόμη γράφεται ή μια γραμμή που ο λογαριασμός είχε ήδη. Καλέστε ξανά μόλις το lesson_plans εδώ έχει πλάνο που ολοκληρώθηκε.

Σφάλματα

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υποχρεωτικό

Παράδειγμα

curl -X PUT "https://api.getlingara.com/v1/embed/players/$PLAYER_REF/link" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

Προτιμάτε μια βιβλιοθήκη; Δείτε την ενότητα Βιβλιοθήκες.