DocsΑυθεντικοποίηση
Μάθετε πώς να αυθεντικοποιείστε με το API της Cost+
Όλη η επικοινωνία με το API της Cost+ απαιτεί TLS 1.2 ή νεότερο και HTTP Basic Authentication.
Πώς Λειτουργεί το Basic Auth
Αυθεντικοποιηθείτε χρησιμοποιώντας το κλειδί API ως όνομα χρήστη με κενό κωδικό πρόσβασης. Κωδικοποιήστε σε Base64 το αλφαριθμητικό \{api_key\}: (σημειώστε την άνω κάτω τελεία στο τέλος — ο κωδικός πρόσβασης είναι κενός).
Η προκύπτουσα κεφαλίδα Authorization έχει την εξής μορφή:
Authorization: Basic aHVudGVyMjo=Μην εκθέτετε ποτέ το κλειδί API σε κώδικα πλευράς πελάτη ή δημόσια αποθετήρια. Κρατήστε το μόνο στην πλευρά του διακομιστή.
Χρήση cURL
Ενσωματωμένη υποστήριξη (συνιστάται)
Το cURL υποστηρίζει εγγενώς το Basic Auth με τη σημαία -u. Περάστε το κλειδί API ακολουθούμενο από άνω κάτω τελεία:
curl -u YOUR_API_KEY: https://api.costplus.online/v1/orders/Χειροκίνητη κωδικοποίηση Base64
Αν προτιμάτε να κατασκευάσετε την κεφαλίδα μόνοι σας, πρώτα κωδικοποιήστε το κλειδί:
echo -n "YOUR_API_KEY:" | base64Στη συνέχεια περάστε την κωδικοποιημένη τιμή στην κεφαλίδα Authorization:
curl -H "Authorization: Basic YOUR_BASE64_ENCODED_KEY" https://api.costplus.online/v1/orders/Η άνω κάτω τελεία μετά το κλειδί API είναι απαραίτητη — διαχωρίζει το όνομα χρήστη από τον (κενό) κωδικό πρόσβασης στο σχήμα Basic Auth.
Κωδικοί Κατάστασης HTTP
Το API χρησιμοποιεί τυπικούς κωδικούς κατάστασης HTTP για να υποδείξει το αποτέλεσμα ενός αιτήματος.
| Κωδικός Κατάστασης | Σημασία | Περιγραφή |
|---|---|---|
| 200 | OK | Το αίτημα ολοκληρώθηκε επιτυχώς. |
| 201 | Created | Ο πόρος δημιουργήθηκε επιτυχώς. |
| 400 | Bad Request | Το αίτημα ήταν ελαττωματικό ή λείπουν απαιτούμενα πεδία. |
| 401 | Unauthorized | Η αυθεντικοποίηση απέτυχε — ελέγξτε το κλειδί API σας. |
| 403 | Forbidden | Δεν έχετε δικαίωμα πρόσβασης σε αυτόν τον πόρο. |
| 404 | Not Found | Ο ζητούμενος πόρος δεν υπάρχει. |
| 500 | Internal Server Error | Κάτι πήγε στραβά στην πλευρά μας. |
| 502 | Bad Gateway | Σφάλμα υπηρεσίας upstream. |
| 503 | Service Unavailable | Το API είναι προσωρινά μη διαθέσιμο. |
| 504 | Gateway Timeout | Η υπηρεσία upstream δεν απάντησε εγκαίρως. |