Contents

the email tool that makes email marketing simple

Sign Up FreeNo credit card required.
maildroppa-promo-notebookmaildroppa-promo-spaceship

Δημιουργία και διαχείριση του API key σας

Published: · Last updated: · By

In brief

Μάθετε να δημιουργείτε, αντιγράφετε, χρησιμοποιείτε, περιστρέφετε και διαγράφετε με ασφάλεια το κλειδί API του Maildroppa για διακομιστικές ενσωματώσεις.

Η σελίδα API Key παρέχει σε ένα εξωτερικό σύστημα πιστοποιημένη πρόσβαση στα υποστηριζόμενα endpoints του Maildroppa API στον λογαριασμό σας.

Μπορείτε να δημιουργήσετε ένα API key, να αντιγράψετε την πλήρη μυστική τιμή του, να το επαναφέρετε με ασφάλεια περιστρέφοντάς το ή να το διαγράψετε όταν δεν το χρειάζεστε πλέον. Το ίδιο key λογαριασμού μπορεί να χρησιμοποιηθεί από ενσωματώσεις στην πλευρά του διακομιστή και από triggers αιτημάτων API στα Maildroppa Automations.

Ένα API key αντιπροσωπεύει τον λογαριασμό σας στο Maildroppa. Αντιμετωπίστε το όπως έναν κωδικό πρόσβασης: οποιοσδήποτε αποκτήσει το key μπορεί να καλεί τα endpoints του API που είναι διαθέσιμα σε αυτό, μέχρι να το περιστρέψετε ή να το διαγράψετε.

API Key: πλήρης σελίδα API key

Για τι προορίζεται το API Key

Χρησιμοποιήστε το API key όταν λογισμικό εκτός Maildroppa χρειάζεται να λειτουργεί με το Maildroppa χωρίς διαδραστική σύνδεση χρήστη.

Τυπικά παραδείγματα περιλαμβάνουν:

  • Συγχρονισμό συνδρομητών με CRM, κατάστημα, σύστημα μελών ή εσωτερική βάση δεδομένων.
  • Δημιουργία ή ενημέρωση συνδρομητών από εφαρμογή στην πλευρά του διακομιστή.
  • Ανάγνωση ή διαχείριση tags, πεδίων, τιμών πεδίων και segments μέσω υποστηριζόμενων endpoints.
  • Αποστολή προσαρμοσμένων events σε trigger αιτήματος API σε ένα Automation.
  • Αποστολή transactional Email Messages μέσω του API.
  • Διαχείριση συνδρομών webhook μέσω API.

Το API key προορίζεται για επικοινωνία server-to-server. Δεν προορίζεται για κώδικα που εκτελείται στο πρόγραμμα περιήγησης ενός επισκέπτη, σε δημόσιο ιστότοπο, σε εφαρμογή για κινητά ή σε ενσωματωμένη φόρμα εγγραφής.

Η σελίδα φέρει επί του παρόντος την ένδειξη “beta”. Χρησιμοποιήστε την OpenAPI τεκμηρίωση στον σύνδεσμο ως πηγή για τα endpoints, τα σώματα αιτημάτων, τις παραμέτρους και τα σχήματα αποκρίσεων που υποστηρίζονται επί του παρόντος από το API.

Άνοιγμα της σελίδας API Key

Ανοίξτε τις “Settings”, αναπτύξτε την ενότητα “Developers” και επιλέξτε “API key”.

Μπορείτε επίσης να ανοίξετε απευθείας τη σελίδα στη διεύθυνση:

https://app.maildroppa.com/settings/developers/api-key

Η σελίδα περιέχει:

  • Ένα πλαίσιο API key με σήμα beta.
  • Έναν σύνδεσμο “View OpenAPI docs”.
  • Μια κενή κατάσταση και το κουμπί “Create API key” όταν δεν υπάρχει key.
  • Μια καλυμμένη αναπαράσταση του τρέχοντος key όταν υπάρχει.
  • Ένα κουμπί “Copy” που αντιγράφει το πλήρες key.
  • Ενέργειες “Rotate API key” και “Delete API key” για την αντικατάσταση ή την αφαίρεση του τρέχοντος key.

Το Maildroppa επιτρέπει ένα API key ανά λογαριασμό. Η σελίδα δεν δημιουργεί ξεχωριστά keys για μεμονωμένες εφαρμογές, περιβάλλοντα ή μέλη ομάδας.

API Key: κενή κατάσταση API key

Δημιουργία API Key

Όταν στη σελίδα εμφανίζεται η ένδειξη “No API key yet”, κάντε κλικ στο “Create API key”.

Το Maildroppa δημιουργεί το key αμέσως. Δεν υπάρχει παράθυρο επιβεβαίωσης για αυτήν την αρχική δημιουργία. Όσο εκτελείται το αίτημα, το κουμπί αλλάζει σε “Creating API key” και η σελίδα απενεργοποιεί προσωρινά τις περαιτέρω ενέργειες key.

Μετά τη δημιουργία του key:

  • Η κενή κατάσταση εξαφανίζεται.
  • Εμφανίζεται ένα καλυμμένο key.
  • Οι ενέργειες “Copy”, “Rotate API key” και “Delete API key” γίνονται διαθέσιμες.
  • Το Maildroppa εμφανίζει μήνυμα επιτυχίας “API key updated”.

Αν υπάρχει ήδη άλλο key για τον λογαριασμό, το Maildroppa δεν δημιουργεί δεύτερο. Χρησιμοποιήστε το υπάρχον key ή περιστρέψτε το.

Κατανόηση του καλυμμένου key

Η σελίδα δεν εμφανίζει το πλήρες μυστικό ως απλό κείμενο. Εμφανίζει τους πρώτους πέντε χαρακτήρες ακολουθούμενους από πέντε αστερίσκους, για παράδειγμα:

a1b2c*****

Αυτό είναι μόνο οπτική κάλυψη. Οι αστερίσκοι δεν αντιπροσωπεύουν το πραγματικό μήκος του key και η καλυμμένη τιμή δεν μπορεί να χρησιμοποιηθεί για αίτημα API.

Κάντε κλικ στο “Copy” για να γράψετε το πλήρες τρέχον key στο πρόχειρό σας. Μετά από επιτυχή αντιγραφή, το κουμπί αλλάζει στιγμιαία σε “Copied!”.

Το key παραμένει καλυμμένο όταν επιστρέφετε στη σελίδα, αλλά το “Copy” συνεχίζει να αντιγράφει την πλήρη τρέχουσα τιμή. Επομένως, δεν χρειάζεται να περιστρέψετε ένα έγκυρο key απλώς επειδή δεν το αποθηκεύσατε κατά τη δημιουργία.

API Key: αντιγραφή καλυμμένου API key

Ασφαλής αποθήκευση του key

Μεταφέρετε το αντιγραμμένο key απευθείας στον χώρο αποθήκευσης μυστικών που χρησιμοποιεί η ενσωμάτωση.

Κατάλληλες τοποθεσίες περιλαμβάνουν:

  • Έναν διαχειριζόμενο διαχειριστή μυστικών.
  • Προστατευμένη διαμόρφωση περιβάλλοντος διακομιστή.
  • Ένα κρυπτογραφημένο μυστικό ανάπτυξης.
  • Έναν διαχειριστή κωδικών πρόσβασης που χρησιμοποιείται για λειτουργική ανάκτηση.

Μην αποθηκεύετε το key σε:

  • JavaScript στην πλευρά του browser ή άλλο frontend bundle που μπορεί να ληφθεί.
  • Δημόσιο ή ιδιωτικό αρχείο πηγαίου κώδικα που έχει υποβληθεί σε repository.
  • URL ή παράμετρο query.
  • Δημόσια τεκμηρίωση, στιγμιότυπα οθόνης, μηνύματα υποστήριξης ή trackers ζητημάτων.
  • Κοινόχρηστα application logs, events analytics ή reports σφαλμάτων.
  • Μη κρυπτογραφημένο υπολογιστικό φύλλο ή απλή ομαδική συνομιλία.

Μην προσθέτετε το key σε παράδειγμα curl που θα αντιγραφεί σε τεκμηρίωση ή σε ιστορικό shell κοινόχρηστο με άλλα άτομα. Προτιμήστε μια μεταβλητή περιβάλλοντος όπως MAILDROPPA_API_KEY.

Χρήση του API Key

Στείλτε το πλήρες key στην κεφαλίδα HTTP αιτήματος X-API-Key:

X-API-Key: your-complete-api-key

Μην το στέλνετε ως Bearer token. Το Maildroppa αναμένει X-API-Key, όχι Authorization: Bearer ....

Το production API και η διαδραστική OpenAPI τεκμηρίωσή του είναι διαθέσιμα στη διεύθυνση:

https://api.maildroppa.com

Κάντε κλικ στο “View OpenAPI docs” στη σελίδα API Key για να ανοίξετε την τεκμηρίωση σε νέα καρτέλα του browser. Επιλέξτε εκεί ένα endpoint για να εξετάσετε τη μέθοδό του, τη διαδρομή, τις παραμέτρους, το σώμα αιτήματος, τον τύπο απόκρισης και τους πιθανούς κωδικούς κατάστασης.

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

Το ακόλουθο παράδειγμα ανακτά την πρώτη σελίδα συνδρομητών. Διαβάζει το key από μεταβλητή περιβάλλοντος αντί να το τοποθετεί απευθείας στην εντολή:

curl --request GET \
  --url 'https://api.maildroppa.com/subscribers?pageNumber=1' \
  --header 'Accept: application/json' \
  --header "X-API-Key: ${MAILDROPPA_API_KEY}"

Ορίστε τη μεταβλητή στο ασφαλές περιβάλλον στο οποίο εκτελείται η ενσωμάτωση. Η ακριβής μέθοδος, διαδρομή, παράμετροι query και σώμα εξαρτώνται από το endpoint. Αντιγράψτε αυτές τις λεπτομέρειες από την OpenAPI τεκμηρίωση αντί να τις μαντεύετε από τις διαθέσιμες ενέργειες στην εφαρμογή Maildroppa.

Αιτήματα με σώματα JSON

Για ένα αίτημα που στέλνει JSON, συμπεριλάβετε επίσης:

Content-Type: application/json

Για παράδειγμα, η βασική δομή είναι:

curl --request POST \
  --url 'https://api.maildroppa.com/example-endpoint' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-API-Key: ${MAILDROPPA_API_KEY}" \
  --data '{"example":"value"}'

Τα /example-endpoint και το σώμα του είναι placeholders. Αντικαταστήστε τα με ένα τεκμηριωμένο endpoint και το τεκμηριωμένο σχήμα αιτήματός του.

Σε τι έχει πρόσβαση το key

Το key λειτουργεί μόνο με endpoints που υποστηρίζουν έλεγχο ταυτότητας μέσω API key. Μια σελίδα ή ένα αίτημα που χρησιμοποιείται εσωτερικά από την εφαρμογή Maildroppa δεν αποτελεί αυτόματα μέρος του δημόσιου API πελατών.

Η OpenAPI τεκμηρίωση εμφανίζει το υποστηριζόμενο API πελατών. Αν μια διαδρομή δεν τεκμηριώνεται για χρήση API key, μην υποθέσετε ότι το key μπορεί να έχει πρόσβαση σε αυτήν.

Η σελίδα API Key δεν προσφέρει scopes ή checkbox δικαιωμάτων ανά endpoint. Επομένως, το τρέχον key λογαριασμού πρέπει να αντιμετωπίζεται ως διαπιστευτήριο υψηλής αξίας, ακόμη και αν μία ενσωμάτωση χρησιμοποιεί μόνο ένα endpoint.

Όρια ρυθμού

Η τρέχουσα σύμβαση OpenAPI τεκμηριώνει τα εξής όρια για API key:

  • Προεπιλεγμένο API πελατών: 300 αιτήματα ανά λεπτό και 2.000 αιτήματα ανά ώρα.
  • Events API στο /events: 100 αιτήματα ανά δευτερόλεπτο με χωρητικότητα burst 500 αιτημάτων.

Αυτά τα όρια εφαρμόζονται στον λογαριασμό Maildroppa και όχι ανεξάρτητα σε κάθε script που μοιράζεται το key. Επομένως, αρκετές ενσωματώσεις μπορούν να καταναλώνουν το ίδιο διαθέσιμο όριο.

Όταν το Maildroppa επιστρέφει 429 Too Many Requests, σταματήστε την αποστολή νέων αιτημάτων και τηρήστε την κεφαλίδα απόκρισης Retry-After όταν υπάρχει. Χρησιμοποιήστε ουρά και ελεγχόμενο backoff αντί να ξεκινάτε πολλές παράλληλες επαναλήψεις.

Οι πολιτικές ορίων ρυθμού μπορεί να εξελιχθούν όσο το API βρίσκεται σε beta. Ελέγξτε τις πληροφορίες στην κορυφή της OpenAPI τεκμηρίωσης πριν σχεδιάσετε ενσωματώσεις μεγάλου όγκου.

Χρήση του key για αιτήματα Automation API

Ένα Automation μπορεί να ξεκινήσει όταν το σύστημά σας στείλει ένα προσαρμοσμένο event στο Events API του Maildroppa.

Όταν ρυθμίζετε ένα trigger “API request”, το Maildroppa χρησιμοποιεί το ίδιο API key λογαριασμού που διαχειρίζεστε σε αυτήν τη σελίδα. Η ρύθμιση του trigger μπορεί να δημιουργήσει το key όταν δεν υπάρχει και να αντιγράψει ένα έτοιμο αίτημα curl που περιέχει το πλήρες key.

Αυτό έχει δύο σημαντικές συνέπειες:

  • Η περιστροφή ή η διαγραφή του key λογαριασμού επηρεάζει επίσης τα συστήματα που στέλνουν προσαρμοσμένα events στα Automations.
  • Ένα αντιγραμμένο παράδειγμα αιτήματος Automation περιέχει το μυστικό στο πρόχειρο, παρότι το key είναι καλυμμένο στην οθόνη.

Πριν περιστρέψετε ή διαγράψετε το key, συμπεριλάβετε κάθε trigger αιτήματος API και κάθε εξωτερικό αποστολέα event στην απογραφή των ενσωματώσεών σας.

Επαναφορά ή αντικατάσταση του API Key

Χρησιμοποιήστε το “Rotate API key” όταν χρειάζεται να επαναφέρετε ή να αντικαταστήσετε το τρέχον διαπιστευτήριο. Το Maildroppa δημιουργεί νέο key και ακυρώνει το προηγούμενο στο πλαίσιο της ίδιας ενέργειας.

Χρησιμοποιήστε την περιστροφή όταν:

  • Το key ενδέχεται να έχει εκτεθεί.
  • Ένα άτομο ή ένας πάροχος που γνώριζε το key δεν χρειάζεται πλέον πρόσβαση.
  • Η πολιτική ασφαλείας σας απαιτεί περιοδική αντικατάσταση διαπιστευτηρίων.
  • Θέλετε να αντικαταστήσετε ένα key που είναι αποθηκευμένο σε παλιά ή μη ασφαλή τοποθεσία.

Κάντε κλικ στο “Rotate API key” κάτω από το καλυμμένο key. Το Maildroppa ανοίγει ένα παράθυρο προειδοποίησης που εξηγεί ότι το υπάρχον key δεν θα είναι πλέον χρησιμοποιήσιμο.

Κάντε κλικ στο “Rotate API key” στο παράθυρο για να συνεχίσετε ή στο “Cancel” για να διατηρήσετε το τρέχον key.

API Key: επιβεβαίωση περιστροφής API key

Η περιστροφή δεν έχει περίοδο χάριτος

Μετά την επιβεβαίωση της περιστροφής, το παλιό key σταματά να λειτουργεί αμέσως. Το Maildroppa δεν διατηρεί ταυτόχρονα έγκυρα το παλιό και το νέο key.

Επειδή ο λογαριασμός έχει μόνο ένα key, η περιστροφή επηρεάζει κάθε διακομιστή, προγραμματισμένη εργασία, ενσωμάτωση, script και αποστολέα event Automation που το χρησιμοποιεί.

Χρησιμοποιήστε την εξής ακολουθία για προγραμματισμένη περιστροφή:

  1. Καταγράψτε κάθε ενσωμάτωση που χρησιμοποιεί το τρέχον key.
  2. Προετοιμάστε πρόσβαση στη μυστική διαμόρφωση και στη διαδικασία ανάπτυξης κάθε ενσωμάτωσης.
  3. Επιλέξτε ένα σύντομο παράθυρο συντήρησης αν είναι σημαντική η αδιάλειπτη πρόσβαση στο API.
  4. Κάντε κλικ στο “Rotate API key” και, στη συνέχεια, επιβεβαιώστε την προειδοποίηση με “Rotate API key” στο παράθυρο.
  5. Κάντε κλικ στο “Copy” για να αντιγράψετε το πλήρες νέο key.
  6. Αντικαταστήστε αμέσως το μυστικό σε κάθε ενσωμάτωση.
  7. Επανεκκινήστε ή αναπτύξτε ξανά υπηρεσίες που φορτώνουν μυστικά μόνο κατά την εκκίνηση.
  8. Στείλτε ένα ακίνδυνο, τεκμηριωμένο αίτημα για να επαληθεύσετε κάθε ενσωμάτωση.
  9. Ελέγξτε για αποκρίσεις 401 Unauthorized από ξεχασμένη υπηρεσία που εξακολουθεί να χρησιμοποιεί το παλιό key.

Αν θεωρείται ότι το τρέχον key έχει παραβιαστεί, περιστρέψτε το αμέσως και αποδεχτείτε τη σύντομη διακοπή που απαιτείται για την ενημέρωση των νόμιμων συστημάτων.

Διαγραφή του API Key

Διαγράψτε το key όταν ο λογαριασμός δεν πρέπει πλέον να αποδέχεται αιτήματα με έλεγχο ταυτότητας μέσω API key.

Κάντε κλικ στο “Delete API key” κάτω από το καλυμμένο key. Το Maildroppa ανοίγει ένα παράθυρο προειδοποίησης που εξηγεί ότι το key θα αφαιρεθεί οριστικά από τον λογαριασμό.

Κάντε κλικ στο “Delete API key” στο παράθυρο για να το διαγράψετε ή στο “Cancel” για να το διατηρήσετε.

Μετά τη διαγραφή:

  • Το τρέχον key σταματά να λειτουργεί αμέσως.
  • Η σελίδα επιστρέφει στην κατάσταση “No API key yet”.
  • Οι ενσωματώσεις διακομιστή που χρησιμοποιούν το διαγραμμένο key δεν μπορούν πλέον να πιστοποιηθούν.
  • Οι αποστολείς αιτημάτων API των Automations που χρησιμοποιούν αυτό το key δεν μπορούν πλέον να παραδίδουν events.

Η διαγραφή ενός key δεν διαγράφει συνδρομητές, καμπάνιες, tags, πεδία, segments, Automations ή άλλα δεδομένα λογαριασμού. Αφαιρεί το διαπιστευτήριο που χρησιμοποιείται για την πρόσβαση στα υποστηριζόμενα endpoints του API.

Μπορείτε αργότερα να κάνετε κλικ στο “Create API key” για να δημιουργήσετε νέο διαπιστευτήριο. Η διαγραμμένη τιμή δεν επαναφέρεται. Κάθε ενσωμάτωση πρέπει να ενημερωθεί πριν μπορέσει να χρησιμοποιήσει το νέο key.

API Key: επιβεβαίωση διαγραφής API key

Επαναφορά ή διαγραφή: Τι να επιλέξετε;

Επιλέξτε “Rotate API key” όταν η πρόσβαση στο API πρέπει να συνεχιστεί με νέο διαπιστευτήριο.

Επιλέξτε τη διαγραφή όταν η πρόσβαση στο API πρέπει να διακοπεί πλήρως, τουλάχιστον προς το παρόν.

Και οι δύο ενέργειες ακυρώνουν αμέσως το τρέχον key. Η περιστροφή δημιουργεί την αντικατάσταση στο πλαίσιο της ίδιας ενέργειας· η διαγραφή αφήνει τον λογαριασμό χωρίς key.

Συστάσεις ασφαλείας

Διατηρήστε τις κλήσεις API στον διακομιστή σας

Ένα πρόγραμμα περιήγησης ή μια εφαρμογή για κινητά δεν μπορεί να διατηρήσει αξιόπιστα ένα ενσωματωμένο μυστικό. Ο χρήστης μπορεί να επιθεωρήσει την εφαρμογή, τις κεφαλίδες αιτημάτων, τα source maps ή την κίνηση δικτύου και να εξαγάγει το key.

Αν ένας ιστότοπος ή μια εφαρμογή χρειάζεται να ενεργοποιήσει μια ενέργεια, στείλτε πρώτα το αίτημα στο δικό σας πιστοποιημένο backend. Αφήστε το backend να επικυρώσει τον χρήστη και να καλέσει το Maildroppa με το key αποθηκευμένο στον διακομιστή.

Χρησιμοποιήστε τη μικρότερη δυνατή έκθεση

Δώστε το key μόνο στα συστήματα που το χρειάζονται. Μην το διανέμετε σε κάθε προγραμματιστή και μην το επικολλάτε σε πολλά τοπικά αρχεία διαμόρφωσης.

Επειδή η σελίδα διαχειρίζεται επί του παρόντος ένα key για ολόκληρο τον λογαριασμό αντί για πολλά ονομασμένα ή περιορισμένα keys, χρησιμοποιήστε εσωτερική υπηρεσία ενσωμάτωσης ή proxy αν αρκετές εφαρμογές χρειάζονται ισχυρότερη απομόνωση μεταξύ τους.

Αποκρύψτε τις κεφαλίδες αιτημάτων

Ρυθμίστε τα HTTP clients, τα reverse proxies, τα εργαλεία παρατηρησιμότητας και τους reporters σφαλμάτων ώστε να αποκρύπτουν το X-API-Key. Ένα αίτημα μπορεί να λειτουργεί σωστά ενώ ταυτόχρονα διαρρέει το διαπιστευτήριο μέσω καταγραφής αποσφαλμάτωσης.

Διατηρήστε ξεχωριστά τα περιβάλλοντα

Μην επαναχρησιμοποιείτε production key σε τοπική ανάπτυξη, δείγματα κώδικα, στιγμιότυπα οθόνης ή test fixtures. Αποθηκεύετε τα μυστικά ανά περιβάλλον σε ξεχωριστούς χώρους αποθήκευσης μυστικών.

Ο σύνδεσμος “View OpenAPI docs” κατευθύνει αυτόματα τους production χρήστες στην production τεκμηρίωση API. Επαληθεύετε πάντα το hostname πριν στείλετε πραγματικό key.

Περιστρέψτε το μετά από κάθε υποψία έκθεσης

Η διαγραφή ενός μηνύματος, commit repository, γραμμής log ή στιγμιότυπου οθόνης δεν αποδεικνύει ότι κανείς δεν αντέγραψε το key. Αν εκτέθηκε η πλήρης τιμή, περιστρέψτε το.

Διαχείριση σφαλμάτων API

Χρησιμοποιήστε τον κωδικό κατάστασης HTTP και το τεκμηριωμένο σώμα απόκρισης για να αποφασίσετε τι πρέπει να κάνει η ενσωμάτωση.

Συνηθισμένες περιπτώσεις περιλαμβάνουν:

  • 400 Bad Request — Η διαδρομή, η παράμετρος ή το σώμα JSON δεν ικανοποιεί τη σύμβαση του endpoint. Συγκρίνετε το αίτημα με το σχήμα OpenAPI.
  • 401 Unauthorized — Η κεφαλίδα X-API-Key λείπει, είναι κενή, μη έγκυρη, διαγραμμένη ή περιέχει παλιά τιμή μετά από περιστροφή.
  • 403 Forbidden — Το πιστοποιημένο key δεν επιτρέπεται να χρησιμοποιήσει αυτήν τη λειτουργία.
  • 404 Not Found — Η διαδρομή ή ο αναφερόμενος πόρος δεν υπάρχει σε αυτόν τον λογαριασμό.
  • 429 Too Many Requests — Η ενσωμάτωση έφτασε ένα όριο ρυθμού API. Διακόψτε προσωρινά τα αιτήματα και τηρήστε την κεφαλίδα Retry-After όταν υπάρχει.
  • 5xx — Το Maildroppa δεν μπόρεσε να ολοκληρώσει το αίτημα. Επαναλάβετε ασφαλείς λειτουργίες με περιορισμένο εκθετικό backoff και καταγραφή που δεν περιλαμβάνει το API key.

Μην επαναλαμβάνετε κάθε αποτυχία χωρίς έλεγχο. Διορθώστε τις αποκρίσεις 400, 401, 403 και τις περισσότερες 404 πριν στείλετε ξανά το ίδιο αίτημα.

Για αιτήματα που μεταβάλλουν δεδομένα, επιβεβαιώστε τη συμπεριφορά επανάληψης και idempotency του endpoint πριν επαναλάβετε αυτόματα ένα αίτημα. Μια αποτυχία σύνδεσης δεν αποδεικνύει πάντα ότι το Maildroppa δεν έκανε καμία αλλαγή.

Αντιμετώπιση προβλημάτων

Το “Create API key” εξακολουθεί να εμφανίζεται

Δεν υπάρχει επί του παρόντος key στον λογαριασμό. Κάντε κλικ στο κουμπί μία φορά και περιμένετε να ολοκληρωθεί το αίτημα.

Αν η δημιουργία αποτύχει, φορτώστε ξανά τη σελίδα πριν προσπαθήσετε ξανά. Μια άλλη σελίδα ή ρύθμιση Automation μπορεί να έχει ήδη δημιουργήσει το key λογαριασμού.

Το key στη σελίδα φαίνεται υπερβολικά σύντομο

Η σελίδα εμφανίζει σκόπιμα μόνο τους πρώτους πέντε χαρακτήρες και *****. Κάντε κλικ στο “Copy” για να αντιγράψετε την πλήρη τιμή. Μην στέλνετε το καλυμμένο κείμενο σε αίτημα.

Το “Copy” δεν αλλάζει σε “Copied!”

Το πρόγραμμα περιήγησης μπορεί να έχει αποκλείσει την πρόσβαση στο πρόχειρο. Διατηρήστε τη σελίδα στην ενεργή καρτέλα, επιτρέψτε την πρόσβαση στο πρόχειρο αν ζητηθεί και κάντε ξανά κλικ στο “Copy”.

Μην προσπαθήσετε να ανακατασκευάσετε το key από το καλυμμένο κείμενο.

Ένα αίτημα επιστρέφει 401 Unauthorized

Ελέγξτε ότι:

  • Το όνομα της κεφαλίδας είναι ακριβώς X-API-Key.
  • Η κεφαλίδα περιέχει την πλήρη τιμή, χωρίς τους ορατούς αστερίσκους.
  • Η ενσωμάτωση δεν στέλνει αντί γι’ αυτό Authorization: Bearer.
  • Δεν προστέθηκαν κενά, εισαγωγικά ή νέα γραμμή στο μυστικό.
  • Κανείς δεν περιστρέψε ή διέγραψε το key λογαριασμού.
  • Έγινε επανεκκίνηση μιας υπηρεσίας αν διαβάζει μεταβλητές περιβάλλοντος μόνο κατά την εκκίνηση.
  • Το αίτημα στέλνεται στο σωστό περιβάλλον API του Maildroppa.

Μία ενσωμάτωση λειτουργεί, αλλά μια άλλη σταμάτησε μετά την περιστροφή

Η δεύτερη ενσωμάτωση πιθανότατα εξακολουθεί να χρησιμοποιεί το παλιό key. Δεν υπάρχει περίοδος επικάλυψης. Ενημερώστε το μυστικό της και επανεκκινήστε κάθε διεργασία που αποθηκεύει στη μνήμη τη διαμόρφωση.

Η σελίδα OpenAPI λειτουργεί, αλλά ένα endpoint επιστρέφει 403

Δεν υποστηρίζουν όλα τα endpoints της εφαρμογής έλεγχο ταυτότητας μέσω API key. Χρησιμοποιήστε μια λειτουργία που τεκμηριώνεται για το API πελατών και επιβεβαιώστε τις απαιτήσεις πιστοποίησής της στη σελίδα OpenAPI.

Τα αιτήματα επιστρέφουν 429 Too Many Requests

Μειώστε τις αιχμές αιτημάτων, τοποθετήστε την εργασία σε ουρά και επαναλάβετε μετά την καθυστέρηση που επιστρέφει το API. Αποφύγετε καταιγίδες παράλληλων επαναλήψεων. Αν αρκετές εφαρμογές μοιράζονται το ένα key λογαριασμού, συντονίστε τον όγκο των αιτημάτων τους επειδή μοιράζονται τα όρια API του λογαριασμού.

Συνιστώμενη λίστα ελέγχου ρύθμισης

Πριν θέσετε μια ενσωμάτωση σε τακτική χρήση, επιβεβαιώστε ότι:

  • Το key αποθηκεύεται μόνο σε διαμόρφωση μυστικών στην πλευρά του διακομιστή.
  • Τα αιτήματα χρησιμοποιούν την κεφαλίδα X-API-Key.
  • Η ενσωμάτωση χρησιμοποιεί το https://api.maildroppa.com σε production.
  • Κάθε μέθοδος, διαδρομή, παράμετρος και σώμα JSON ακολουθεί την OpenAPI τεκμηρίωση.
  • Τα logs και τα reports σφαλμάτων αποκρύπτουν το key.
  • Έχουν ρυθμιστεί timeouts και περιορισμένες επαναλήψεις.
  • Παρακολουθούνται τα 401, 403, 429 και τα σφάλματα διακομιστή.
  • Έχει καταγραφεί ο υπεύθυνος της ενσωμάτωσης.
  • Κάθε σύστημα που μοιράζεται το key λογαριασμού περιλαμβάνεται στο σχέδιο περιστροφής.
  • Ένα παραβιασμένο key μπορεί να περιστραφεί γρήγορα.

Η σελίδα API Key είναι σκόπιμα μικρή, αλλά οι ενέργειές της επηρεάζουν κάθε ενσωμάτωση API που είναι συνδεδεμένη με τον λογαριασμό. Δημιουργήστε το key μόνο όταν χρειάζεται, διατηρήστε το σε αξιόπιστους διακομιστές και σχεδιάστε την περιστροφή ως αλλαγή διαπιστευτηρίου σε επίπεδο λογαριασμού.

Ready to Send Better Emails?

Stop juggling bloated tools or overpriced plans. Maildroppa offers personal support, GDPR-level privacy, and powerful email marketing - starting free forever.

Sign Up For Free

No credit card required. No time limit.