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

Τεκμηρίωση API

Βήμα 1 – Βασικός έλεγχος

Ένα αίτημα που επιβεβαιώνει ότι το token και η σύνδεσή σας με το API είναι σωστά.

Πριν προχωρήσετε, βεβαιωθείτε ότι το σύστημά σας επικοινωνεί σωστά με το API. Το endpoint ελέγχου αυθεντικοποιεί το token σας ακριβώς όπως όλα τα υπόλοιπα endpoints: αν ο έλεγχος περάσει, το token είναι σωστό.

curl https://provider-staging.flexy.gr/api/v1/health/auth/ \
  -H "Authorization: Bearer <token>"

Στη θέση του <token> βάλτε το staging token που βλέπετε στη σελίδα συνεργάτη.

Όλα είναι σωστά

Το API απαντά με HTTP 200:

{
  "health": {
    "status": "ok",
    "environment": "staging",
    "client": {
      "name": "Default API Key"
    }
  }
}
ΠεδίοΤι σημαίνει
statusΠάντα ok: το token σας έγινε δεκτό.
environmentΤο περιβάλλον που σας απάντησε. Για τις δοκιμές σας πρέπει να είναι staging.
client.nameΤο API key στο οποίο ανήκει το token.

Κάτι δεν πάει καλά

Τα σφάλματα ακολουθούν τη μορφή σφαλμάτων. Βρείτε τη γραμμή με το HTTP status και το errors[0].code που πήρατε:

HTTPcodeΑιτίαΤι κάνετε
401not_authenticatedΤο αίτημα δεν έστειλε token.Στείλτε το header Authorization: Bearer <token>.
401token_not_validΤο token δεν αναγνωρίστηκε: δεν αντιγράφηκε ολόκληρο, ανήκει σε άλλο περιβάλλον ή το κλειδί έχει απενεργοποιηθεί.Αντιγράψτε ξανά το staging token και καλέστε το staging URL.
401authentication_failedΜε detail ίσο με API call quota exceeded: ο λογαριασμός σας δεν έχει διαθέσιμες κλήσεις.Γράψτε μας στο [email protected].
403permission_deniedΣτείλατε token σύνδεσης χρήστη (login) αντί για το API token.Χρησιμοποιήστε το API token που σας στείλαμε.
301—Το URL δεν τελειώνει σε / και η απάντηση είναι ανακατεύθυνση χωρίς σώμα.Καλέστε το /api/v1/health/auth/ με την κάθετο στο τέλος.

Όταν πάρετε 200, η σύνδεσή σας είναι έτοιμη. Συνεχίστε στο βήμα 2.