Deine erste API-Anfrage
Mit einem API-Schlüssel zum ersten Request und anschließend eine E-Mail von einem E-Mail-Postfach senden, das du kontrollierst.
503 integrations_disabled. Diese Beispiele beschreiben die aktivierte API.Zugangsdaten erstellen
Öffne Konto → Integrationen. Autorisiere die benötigten Postfächer und erstelle dann einen REST-API-Zugang mit den erforderlichen Berechtigungen und den ausgewählten Postfächern.
Kopiere das Secret, sobald es angezeigt wird. Es wird nur einmal angezeigt. Speichere es als Umgebungsvariable auf dem Server und halte es aus der Versionsverwaltung heraus.
export CHERRYMAIL_API_KEY='your-cm_rest_-credential'Stelle deine erste Anfrage
Rufe dein Konto mit der Berechtigung read ab. Alle Endpunkte verwenden die Basis-URL https://cherrymail.net/api/v1 und einen Bearer-Autorisierungsheader.
curl 'https://cherrymail.net/api/v1/account/' \
-H "Authorization: Bearer $CHERRYMAIL_API_KEY"Erfolgreiche JSON-Antworten verpacken das Ergebnis in data und enthalten eine request_id zur Fehlerbehebung.
E-Mail senden
Verwende Zugangsdaten mit der Berechtigung send und einer aktuellen Freigabe für das ausgewählte E-Mail-Postfach. Ersetze 123 durch die ID deines E-Mail-Postfachs. Der Absender muss mit der Identität des freigegebenen E-Mail-Postfachs übereinstimmen.
curl -X POST 'https://cherrymail.net/api/v1/mailboxes/123/send/' \
-H "Authorization: Bearer $CHERRYMAIL_API_KEY" \
-H "Idempotency-Key: example-request-1042" \
-H "Content-Type: application/json" \
-d '{
"to": [
"recipient@example.com"
],
"subject": "Hello from CherryMail",
"text": "Your first email, sent with the CherryMail API."
}'Verwende für jede beabsichtigte Übermittlung einen eindeutigen Idempotency-Key. Verwende beim Prüfen eines erneuten Versuchs denselben Schlüssel und dieselbe unveränderte Anfrage.
Ergebnis verfolgen
Anfragen zum Erstellen und Ändern geben eine dauerhaft gespeicherte operation_id zurück. Rufe den Vorgang ab, um Status und Ergebnis nachzuverfolgen.