Μετάβαση στο περιεχόμενο
Για προγραμματιστές

Δημιουργία πρόσκλησης

POSThttps://api.reviewit.gr/v1/invitations

Ταυτοποίηση με το κλειδί API της επιχείρησης (Authorization: Bearer rvk_...), όχι με συνεδρία. Με το κλειδί δοκιμής (rvk_test_...) η απάντηση είναι η ίδια, με test: true, αλλά τίποτα δεν αποθηκεύεται, δεν στέλνεται και δεν μετράει στο όριο.

Στείλτε μόνο το email του πελάτη, το μικρό του όνομα (προαιρετικό) και τον αριθμό παραγγελίας. Το email στέλνεται μετά την καθυστέρηση που έχει ορίσει η επιχείρηση (24 ώρες από προεπιλογή) και η διεύθυνση σβήνεται μόλις σταλεί, το αργότερο σε 30 ημέρες. Η ίδια παραγγελία δεν στέλνεται δύο φορές, οπότε η επανάληψη μιας κλήσης είναι ασφαλής.

Αν η παραγγελία ή ο πελάτης έχει ήδη προσκληθεί (από την ίδια επιχείρηση τις τελευταίες 90 ημέρες), η απάντηση είναι 200 με state: skipped και reason (duplicate, repeat). Δεν στέλνεται τίποτα σε όποιον έχει ζητήσει να μη λαμβάνει προσκλήσεις (από οποιαδήποτε επιχείρηση) ή έχει ήδη γράψει κριτική για την επιχείρηση, αλλά η απάντηση είναι η ίδια 202 με μια κανονική πρόσκληση: δεν λέμε σε καμία επιχείρηση ποιος έχει γράψει κριτική ή έχει διαγραφεί από τη λίστα.

Η επιχείρηση πρέπει να έχει ενεργοποιήσει τις προσκλήσεις και να έχει επιβεβαιώσει ότι ενημερώνει τους πελάτες της (403 invitations_disabled), να έχει πλάνο (403 plan_required) και να μην έχει συμπληρωθεί το μηνιαίο όριο του πλάνου της (429 monthly_limit: Basic 300, Pro 1000, Premium 5000, Enterprise χωρίς όριο).

Παράμετροι

Κεφαλίδες

  • Authorization string απαιτείται

    Bearer ΤΟ_ΚΛΕΙΔΙ_ΣΑΣ

    Το κλειδί API της επιχείρησης (rvk_...), που δημιουργεί ο ιδιοκτήτης στη σελίδα «Η επιχείρησή μου»

  • Content-Type string απαιτείται

    application/json

    Το σώμα του αιτήματος είναι JSON.

Σώμα αιτήματος

  • email stringemailαπαιτείται

    Το email του πελάτη

  • firstName stringέως 80 χαρακτήρες

    Το μικρό όνομα του πελάτη (προαιρετικό)

  • orderRef stringέως 100 χαρακτήρεςαπαιτείται

    Ο αριθμός παραγγελίας του καταστήματός σας: μία πρόσκληση ανά παραγγελία

Παράδειγμα αιτήματος

Terminal window
curl -X POST https://api.reviewit.gr/v1/invitations \
-H "Authorization: Bearer ΤΟ_ΚΛΕΙΔΙ_ΣΑΣ" \
-H "Content-Type: application/json" \
-d '{"email":"pelatis@example.gr","firstName":"Μαρία","orderRef":"1001"}'

Αντικαταστήστε το ΤΟ_ΚΛΕΙΔΙ_ΣΑΣ. Ξεκινήστε με το κλειδί δοκιμής: δεν στέλνεται τίποτα.

Απαντήσεις

200

Δεν θα σταλεί τίποτα (skipped): η παραγγελία ή ο πελάτης έχει ήδη προσκληθεί

  • state stringskipped
  • reason stringduplicaterepeat
  • test boolean
Παράδειγμα απάντησης
{
"state": "skipped",
"reason": "duplicate"
}

202

Η πρόσκληση μπήκε στη σειρά για αποστολή

  • state stringqueued
  • test boolean

    Μόνο με το κλειδί δοκιμής: δεν μπήκε τίποτα στη σειρά

Παράδειγμα απάντησης
{
"state": "queued"
}

401

Λείπει ή είναι λάθος το κλειδί API

403

invitations_disabled ή plan_required

422

Μη έγκυρο πεδίο: validation_failed, με το field και ένα message

  • error stringvalidation_failed
  • field string
  • message string
Παράδειγμα απάντησης
{
"error": "validation_failed",
"field": "email",
"message": "Μη έγκυρη διεύθυνση email"
}

429

monthly_limit: συμπληρώθηκε το μηνιαίο όριο του πλάνου

Τι να κάνετε σε κάθε απάντηση: απαντήσεις και σφάλματα.