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