API-Schlüssel

Mit API-Schlüsseln können Maschinen auf dein Cache Rocket-Konto reagieren: das WordPress-Plugin, ein Deploy-Webhook von deinem CI oder deine eigenen Skripte, die die öffentliche API aufrufen.

du befinden sich unter Konto → Konto im Abschnitt API-Schlüssel.

Das Schlüsselpaar#

Öffentlicher Schlüssel

Identifiziert dein Konto. Es ist kein Geheimnis im kryptografischen Sinne, es gibt aber auch keinen Grund, es zu veröffentlichen. Immer sichtbar in deinem Konto.

Geheimer Schlüssel

Beweist, dass die Anfrage echt von dir stammt. Behandeln du es genau wie ein Passwort. Wird nur einmal angezeigt, direkt nach der Generierung.

Beide werden bei jeder authentifizierten Maschinenanforderung zusammen gesendet, normalerweise als X-Public-Key- und X-Secret-Key-Header.

Schlüssel generieren#

1. 1

   Öffnen du Konto → Konto

   Scrollen du zum Abschnitt API-Schlüssel.

2. 2

   Klicken du auf Neue API-Schlüssel generieren

   Es wird sofort ein neues Paar erstellt. Alle zuvor ausgegebenen Paare funktionieren nicht mehr. Tun du dies also zu einem Zeitpunkt, an dem du alles, was davon abhängt, aktualisieren können.

3. 3

   Klicken du sofort auf Schlüssel anzeigen

   Dies ist deine einzige Chance, das Geheimnis zu lüften. Es wird einmal abgerufen und dann dauerhaft ausgeblendet.

4. 4

   Bewahren du das Geheimnis an einem sicheren Ort auf

   Ein Passwort-Manager oder der verschlüsselte Geheimspeicher deines CI-Anbieters. Keine Textdatei auf deinem Desktop und keine Chat-Nachricht.

Ablauf#

Schlüssel tragen ein Ablaufdatum, das in deinem Konto daneben angezeigt wird. Sobald es überschritten ist, werden Anfragen, die das Paar verwenden, abgelehnt und Integrationen, die darauf basieren, funktionieren nicht mehr. Notieren du sich das Datum an einer Stelle, an der du es tatsächlich sehen können, und drehen du es, bevor du es erreichen, und nicht danach.

Mit deinen Schlüsseln#

Mit dem WordPress Plugin

Fügen du beide Schlüssel nach der Aktivierung in den Einstellungsbildschirm des Plugins ein. Siehe WordPress Plugin.

Mit Deploy-Webhooks

Senden du sie als Header in der Webhook-Anfrage:

curl -X POST https://api.cacherocket.com/web/v1/public/webhooks/vercel \
  -H "Content-Type: application/json" \
  -H "X-Public-Key: YOUR_PUBLIC_KEY" \
  -H "X-Secret-Key: YOUR_SECRET_KEY" \
  -d '{"hostname":"www.example.com"}'

Die vollständige Einrichtung für jede Plattform finden du unter Trigger bereitstellen.

Direktes Auslösen einer Wärme

Einige Endpunkte akzeptieren die Schlüssel im Anforderungstext anstelle von Headern:

curl -X POST https://cacherocket.com/api/wordpress/triggerWarm \
  -H 'Content-Type: application/json' \
  -d '{"publicKey":"YOUR_KEY","secretKey":"YOUR_SECRET","hostname":"example.com"}'

Schlüssel sicher aufbewahren#

• Übergeben du das Geheimnis niemals an ein Repository, auch nicht an ein privates. Verwenden du Umgebungsvariablen oder den Geheimspeicher deines CI-Anbieters.
• Fügen du es nicht in ein Support-Ticket, Problem oder einen Chat ein. Niemand bei Cache Rocket benötigt deinen geheimen Schlüssel, um dir zu helfen.
• Fügen du es nicht in den Front-End-Code ein. Alles in einem Browser-Bundle ist öffentlich, egal wie es verschleiert ist.
• Sofort drehen, wenn eine Belichtung überhaupt möglich ist. Das Generieren eines neuen Paares dauert Sekunden; Das Aufräumen nach einem geleakten Berechtigungsnachweis ist nicht möglich.

Rotierende Schlüssel ohne Ausfallzeiten#

Durch die Generierung eines neuen Paares wird das alte sofort ungültig, sodass kein Überlappungsfenster entsteht. Planen du den Tausch:

1. 1

   Listen du alles auf, was das aktuelle Paar verwendet

   Normalerweise stellt das WordPress-Plugin Webhooks auf jeder Hosting-Plattform und alle CI-Jobs oder Skripte bereit.

2. 2

   Generieren du das neue Paar und enthüllen du das Geheimnis

   Öffnen du deinen Passwort-Manager, bevor Du klickst.

3. 3

   Aktualisieren du jeden Verbraucher

   Arbeiten du die Liste durch. Integrationen, die noch die alten Schlüssel enthalten, schlagen zu diesem Zeitpunkt bereits fehl, also handeln du umgehend.

4. 4

   Bestätigen du, dass jeder funktioniert

   Speichern du die WordPress-Plugin-Einstellungen erneut, lösen du einen Test-Deploy-Hook aus und prüfen du, ob tatsächlich ein Warmlauf startet.

Häufige Probleme#

Ich erhalte eine 401 oder „unauthorized“ von einem Webhook.

Die Schlüssel sind falsch, abgelaufen oder wurden durch ein neueres Paar ersetzt. Überprüfen du, ob beim Kopieren des Geheimnisses Leerzeichen oder abgeschnittene Werte vorhanden sind, und überprüfen du dann das Ablaufdatum in deinem Konto.

Ich habe den geheimen Schlüssel verloren.

Es kann nicht wiederhergestellt werden. Erzeugen du ein neues Paar und aktualisieren du jede Integration.

Der Reveal-Schlüssel bewirkt nichts oder sagt, dass er bereits enthüllt wurde.

Das Geheimnis dieses Paares wurde bereits einmal enthüllt und kann nicht noch einmal enthüllt werden. Erzeugen du ein neues Paar.

Kann ich mehrere Schlüsselpaare für verschiedene Integrationen haben?

Ein Konto verwendet jeweils ein aktives Paar. Um den Zugriff zwischen Clients oder Umgebungen zu trennen, verwenden du separate Workspacee – siehe Teams und Rollen.

Stoppt das Generieren neuer Schlüssel mein warmers?

Nr. Warmers in Cache Rocket eingeplant, läuft normal weiter. Betroffen sind nur externe Integrationen, die sich mit den alten Schlüsseln authentifizieren.