Schlüssel und Geheimnisse
Speichere die privaten Zugangsdaten deiner App in Atoms Cloud → Schlüssel, damit ihre Werte nicht in Chat und im Quellcode erscheinen und du separate Werte für Test und Produktion verwalten kannst.
Speichere die privaten Zugangsdaten deiner App in Atoms Cloud → Schlüssel, damit ihre Werte nicht in Chat und im Quellcode erscheinen und du separate Werte für Test und Produktion verwalten kannst.
Bevor du Schlüssel verwendest, verbinde das Projekt mit Atoms Cloud. Wenn es nicht verbunden ist, bitte den Agent, Atoms Cloud zu verbinden, oder folge Atoms Cloud.
Einen Schlüssel in Atoms Cloud verwenden
Bevor du beginnst
Bevor du einen Schlüssel hinzufügst, stelle sicher, dass:
- du Atoms im Desktop-Web verwendest.
- das Projekt mit Atoms Cloud verbunden ist.
- du Eigentümer des Arbeitsbereichs bist. Nur Eigentümer des Arbeitsbereichs können neue Schlüssel hinzufügen.
Wenn Schlüssel oder Neuer Schlüssel nicht verfügbar ist, vergewissere dich, dass du das beabsichtigte Projekt geöffnet hast und dass es mit Atoms Cloud verbunden ist. Wenn Neuer Schlüssel weiterhin nicht verfügbar ist, vergewissere dich, dass du Eigentümer des Arbeitsbereichs bist. Wenn Atoms eine Meldung zur Verfügbarkeit des Plans oder der Nutzung anzeigt, folge dem auf dem Bildschirm angezeigten Verfügbarkeits- oder Upgrade-Pfad und versuche es dann erneut.
Einen Testschlüssel hinzufügen
- Öffne das Projekt auf einem Desktop-Gerät.
- Wähle in derselben Symbolleiste des Arbeitsbereichs, in der sich der App-Viewer befindet, Atoms Cloud aus.
- Wähle Schlüssel in der Seitenleiste von Atoms Cloud aus.
- Öffne Testschlüssel und wähle dann In diesem Projekt aus.
- Wähle Neuer Schlüssel aus.
- Fülle die erforderlichen Felder aus:
- Name: Gib einen eindeutigen Referenznamen ein, zum Beispiel RESEND_API_KEY. Verwende Buchstaben, Zahlen und Unterstriche und beginne mit einem Buchstaben oder Unterstrich.
- Wert: Gib die Zugangsdaten genau so ein, wie sie vom Anbieter bereitgestellt wurden.
- Beschreibung: Erkläre, wofür der Schlüssel verwendet wird, zum Beispiel Wird zum Senden von Konto-E-Mails verwendet. Gib den Wert der Zugangsdaten nicht an.
- Wenn du den Schlüssel in anderen Projekten wiederverwenden möchtest, wähle In Bibliothek speichern aus.
- Wähle Hinzufügen aus. Wenn der Schlüssel gespeichert wurde, zeigt Atoms Schlüssel erfolgreich hinzugefügt an.
Einen Testschlüssel hinzufügen
Nur Eigentümer des Arbeitsbereichs können neue Schlüssel hinzufügen. Wenn du einen Schlüssel hinzufügen musst, bitte einen Eigentümer des Arbeitsbereichs darum.
Einen gespeicherten Schlüssel in Chat verwenden
Verweise auf den gespeicherten Schlüssel, anstatt seinen Wert in eine Nachricht einzugeben.
- Öffne den Projekt-Chat in der Desktop-Version von Atoms und gib
#ein. - Wähle Schlüssel aus.
- Suche nach dem gespeicherten Schlüssel und wähle dann seinen Namen aus.
- Teile dem Agent mit, wofür der Schlüssel verwendet wird und was die Integration tun soll.
Das Menü # fügt einen Verweis auf den gespeicherten Schlüssel hinzu, ohne seinen Wert in deine Nachricht einzufügen.
Auf einen gespeicherten Schlüssel in Chat verweisen
Einen gespeicherten Schlüssel testen
- Führe im App-Viewer eine einfache Aktion aus, die den Schlüssel verwendet.
- Bestätige, dass sie das erwartete Ergebnis liefert, zum Beispiel das Zustellen einer Test-E-Mail oder das Zurückgeben von Testdaten.
- Prüfe alle sichtbaren Fehler oder Protokolle und stelle sicher, dass sie den Wert des Schlüssels nicht offenlegen.
Wenn der Dienst dir separate Test- und Live-Schlüssel bereitstellt, verwende beim Erstellen deiner App den Testschlüssel. Verwende den Live-Schlüssel erst, nachdem deine App veröffentlicht wurde. Wenn der Test fehlschlägt, prüfe das Dashboard des Anbieters, um zu bestätigen, dass der Schlüssel aktiv ist und die Berechtigung hat, die angeforderte Aktion auszuführen. Füge den Wert des Schlüssels bei der Fehlerbehebung niemals in Chat ein.
Verstehen, wie Schlüssel funktionieren
Bevor du Schlüssel hinzufügst, ist es hilfreich zu verstehen, was Atoms speichert und wie du deine Zugangsdaten schützt.
Was Atoms speichert
Atoms Cloud → Schlüssel speichert Zugangsdaten, die deine App verwendet, um sich mit externen Diensten zu verbinden, zum Beispiel API-Schlüssel und Zugriffstoken.
Jeder gespeicherte Schlüssel hat einen Namen, eine Beschreibung und einen privaten Wert. Der Name und die Beschreibung helfen dem Agent, zu verstehen, wann der Schlüssel verwendet werden soll, während der private Wert vor Chat verborgen bleibt.
Wo du einen Schlüssel erhältst
Atoms erstellt oder stellt keine Zugangsdaten für externe Dienste bereit. Du musst sie vom jeweiligen Dienstanbieter erhalten. Folge den Anweisungen des Anbieters bei der Auswahl von Berechtigungen, beim Testen des Schlüssels und bei der Prüfung, ob er abläuft.
Private Zugangsdaten geheim halten
Füge private Zugangsdaten niemals in Chat, Quellcode, Code, der im Browser ausgeführt wird, Screenshots, Protokolle oder Support-Nachrichten ein. Speichere sie in Schlüssel und verweise dann per Namen auf den gespeicherten Eintrag.
Wenn ein privater Wert bereits offengelegt wurde, betrachte ihn als kompromittiert und widerrufe oder rotiere ihn über den Anbieter.
Private und browser-sichere Zugangsdaten
Schlüssel kennzeichnet gespeicherte Werte nicht als Öffentlich oder Privat. Das Speichern eines Werts in Schlüssel macht ihn nicht automatisch sicher für die Verwendung in browserseitigem Code. Wenn deine App den Wert im Browser verwendet, können Besucher ihn möglicherweise einsehen.
Prüfe die Dokumentation des Anbieters, bevor du entscheidest, wo du Zugangsdaten verwendest:
- Verwende einen Wert in browserseitigem Code nur dann, wenn der Anbieter ausdrücklich angibt, dass er sicher offengelegt werden kann.
- Bewahre private Zugangsdaten in serverseitiger oder Backend-Logik auf, wo sie für Besucher der App nicht offengelegt werden.
Die Umgebung und Speicherung des Schlüssels auswählen
Beim Hinzufügen eines Schlüssels musst du zwei separate Entscheidungen treffen:
- Welche Umgebung den Schlüssel verwenden wird.
- Ob der Schlüssel in diesem Projekt verbleibt oder für andere Projekte verfügbar sein wird.
Eine Umgebung auswählen
Option | Wann sie verwendet wird |
|---|---|
Testschlüssel | Wird während der Entwicklung und beim Testen deiner App im App-Viewer verwendet. Wenn du keinen separaten Produktionswert hinzufügst, verwendet die veröffentlichte App ebenfalls den Testwert. |
Produktionsschlüssel | Wird von der veröffentlichten App verwendet, wenn sie separate Live-Zugangsdaten benötigt. Produktionswerte werden während des Veröffentlichungsprozesses hinzugefügt und getrennt von Testwerten verwaltet. |
Auswählen, wo der Schlüssel gespeichert werden soll
Option | Wann du sie verwenden solltest |
|---|---|
In diesem Projekt | Wähle dies für einen Schlüssel, der nur vom aktuellen Projekt verwendet werden soll. |
Schlüsselbibliothek | Wähle dies, wenn du einen Schlüssel bewusst in mehreren Projekten wiederverwenden möchtest. Wenn du einen Testschlüssel hinzufügst oder aktualisierst, wähle In Bibliothek speichern, um ihn in der Bibliothek verfügbar zu machen. |
Die Umgebung und der Speicherort sind unabhängig voneinander. Das Speichern eines Testschlüssels in der Schlüsselbibliothek macht ihn wiederverwendbar, aber es macht ihn nicht zu einem Produktionswert.
Verwende standardmäßig In diesem Projekt. Speichere einen Schlüssel nur dann in der Bibliothek, wenn du sicher bist, dass er projektübergreifend geteilt werden soll.
Einen separaten Produktionswert verwenden
Wenn du ein Projekt veröffentlichst, das einen gespeicherten Schlüssel verwendet, fordert dich der Veröffentlichungsablauf möglicherweise auf, Produktionsschlüssel zu konfigurieren. Standardmäßig verwendet die veröffentlichte App den Testwert. Um andere Zugangsdaten zu verwenden, wähle Produktion und speichere einen separaten Wert für den Schlüssel.
Verwende einen separaten Produktionswert, wenn:
- der Anbieter unterschiedliche Test- und Live-Zugangsdaten bereitstellt.
- du nicht möchtest, dass die während der Entwicklung verwendeten Zugangsdaten von der veröffentlichten App verwendet werden.
Produktionswerte werden über den Veröffentlichungsablauf erstellt. Du kannst keinen erstellen, indem du im Tab Produktionsschlüssel Neuer Schlüssel auswählst. Nachdem ein Produktionswert für eine veröffentlichte App konfiguriert wurde, kannst du ihn unter Atoms Cloud → Schlüssel → Produktionsschlüssel anzeigen.
Nachdem du die App veröffentlicht oder aktualisiert hast, wiederhole die relevante User Journey auf der veröffentlichten Website, um zu bestätigen, dass der Produktionsschlüssel korrekt funktioniert. Den vollständigen Bereitstellungsprozess findest du unter Veröffentlichen und bereitstellen.
Zugangsdaten aktualisieren oder rotieren
Einen gespeicherten Testwert aktualisieren
- Öffne Atoms Cloud → Schlüssel → Testschlüssel.
- Öffne je nachdem, wo der Eintrag gespeichert wurde, In diesem Projekt oder Schlüsselbibliothek.
- Wähle den Wert oder die Beschreibung des Schlüssels aus, gib die aktualisierten Informationen ein und wähle dann Aktualisieren.
- Warte auf Speichern erfolgreich und teste dann den betroffenen Ablauf erneut.
Geplante Schlüsselrotation
Folge diesen Schritten, wenn die vorhandenen Zugangsdaten noch sicher sind und du sie ersetzen möchtest, ohne deine App zu unterbrechen:
- Erstelle über den Dienstanbieter Ersatz-Zugangsdaten.
- Ersetze den Testwert in Atoms und teste dann die betroffene Funktion im App-Viewer.
- Wenn die veröffentlichte App einen separaten Produktionswert verwendet, ersetze ihn und veröffentliche das Update.
- Teste dieselbe Funktion auf der veröffentlichten Website.
- Nachdem du bestätigt hast, dass der Ersatz korrekt funktioniert, widerrufe die alten Zugangsdaten über den Anbieter.
Wenn Zugangsdaten möglicherweise offengelegt wurden
Betrachte die Zugangsdaten als kompromittiert und handle sofort:
- Widerrufe oder deaktiviere sie über den Dienstanbieter.
- Erstelle Ersatz-Zugangsdaten.
- Aktualisiere die relevanten Test- und Produktionswerte in Atoms.
- Teste die betroffenen Funktionen erneut sowohl im App-Viewer als auch in der veröffentlichten App.
- Entferne offengelegte Kopien nach Möglichkeit aus Quellcode, Chat, Screenshots und Protokollen.
Das Löschen eines Schlüssels oder das Entfernen seines Werts aus Atoms widerruft die ursprünglichen Zugangsdaten nicht. Du musst sie über den Dienstanbieter widerrufen.
Zugangsdaten entfernen
Bevor du einen gespeicherten Schlüssel löschst, stelle sicher, dass deine App nicht mehr davon abhängt:
- Entferne die Funktion, die den Schlüssel verwendet, oder ersetze ihre Verweise durch einen anderen gespeicherten Schlüssel.
- Widerrufe die ursprünglichen Zugangsdaten über den Dienstanbieter, damit sie nicht mehr verwendet werden können.
- Öffne Atoms Cloud → Schlüssel, finde den inaktiven Eintrag, wähle Löschen und bestätige.
Das Löschen eines Schlüssels kann nicht rückgängig gemacht werden. Es kann auch Vorschauen oder ältere Checkpoints beschädigen, die noch darauf verweisen. Wenn Löschen nicht verfügbar ist, ist der Schlüssel noch als aktiv markiert. Entferne oder ersetze jeden Verweis darauf, bevor du es erneut versuchst.
FAQ
Mein Testschlüssel funktioniert im App-Viewer, aber nicht nach der Veröffentlichung. Warum?
Wenn dein Testschlüssel im App-Viewer funktioniert, die veröffentlichte App aber fehlschlägt, weil ein Schlüssel fehlt oder leer ist:
- Prüfe, ob der relevante Test- oder Produktionswert vor oder nach der letzten Veröffentlichung gespeichert wurde. Wenn er danach gespeichert wurde, veröffentliche erneut, damit die Änderung wirksam wird.
- Vergewissere dich, dass der gespeicherte Schlüssel den korrekten Test- oder Produktionswert hat. Die veröffentlichte App verwendet den Testwert, sofern kein separater Produktionswert konfiguriert ist.
- Prüfe Fehler von nachgelagerten Diensten auf Hinweise. „Unauthorized“ weist häufig auf einen leeren oder falschen Schlüssel für diese Umgebung hin.
Wenn das Problem weiterhin besteht, kontaktiere den Support und gib Folgendes an:
- Projektlink oder Live-URL
- Den Namen des betroffenen Schlüssels und ob der Test- oder Produktionswert das Problem hat
- Den vollständigen Fehler des nachgelagerten Dienstes
- Einen bereinigten Screenshot der Konfigurationsseite
- Ob die Schlüsselkonfiguration vor oder nach der Veröffentlichung gespeichert wurde
Wichtig: Gib nur Schlüsselnamen an. Sende KEINE geheimen Werte, Passwörter oder Token.