Sleutels en geheimen
Sla de privé-inloggegevens van je app op in Atoms Cloud → Sleutels om hun waarden buiten Chat en broncode te houden, en om afzonderlijke Test- en Productiewaarden te beheren.
Sla de privé-inloggegevens van je app op in Atoms Cloud → Sleutels om hun waarden buiten Chat en broncode te houden, en om afzonderlijke Test- en Productiewaarden te beheren.
Voordat je Sleutels gebruikt, verbind je het project met Atoms Cloud. Als het niet is verbonden, vraag de Agent om Atoms Cloud te verbinden of volg Atoms Cloud.
Een sleutel gebruiken in Atoms Cloud
Voordat je begint
Voordat je een sleutel toevoegt, controleer het volgende:
- Je gebruikt Atoms op desktopweb.
- Het project is verbonden met Atoms Cloud.
- Je bent een eigenaar van de werkruimte. Alleen eigenaren van de werkruimte kunnen nieuwe sleutels toevoegen.
Als Sleutels of Nieuwe sleutel niet beschikbaar is, controleer dan of je het bedoelde project hebt geopend en of het is verbonden met Atoms Cloud. Als Nieuwe sleutel nog steeds niet beschikbaar is, controleer dan of je een eigenaar van de werkruimte bent. Als Atoms een bericht over beschikbaarheid van een plan of gebruik toont, volg dan het beschikbaarheids- of upgradepad op het scherm en probeer het daarna opnieuw.
Een Testsleutel toevoegen
- Open het project op een desktopapparaat.
- Selecteer in dezelfde werkruimtewerkbalk waar de App Viewer staat, Atoms Cloud.
- Selecteer Sleutels in de zijbalk van Atoms Cloud.
- Open Testsleutels en selecteer vervolgens In dit project.
- Selecteer Nieuwe sleutel.
- Vul de verplichte velden in:
- Naam: Voer een duidelijke referentienaam in, zoals RESEND_API_KEY. Gebruik letters, cijfers en underscores, en begin met een letter of underscore.
- Waarde: Voer de inloggegevens exact in zoals geleverd door de provider.
- Beschrijving: Leg uit waarvoor de sleutel is, zoals Gebruikt om account-e-mails te verzenden. Voeg de waarde van de inloggegevens niet toe.
- Als je de sleutel in andere projecten wilt hergebruiken, selecteer dan Opslaan in bibliotheek.
- Selecteer Toevoegen. Wanneer de sleutel is opgeslagen, toont Atoms Sleutel succesvol toegevoegd.
Een Testsleutel toevoegen
Alleen eigenaren van de werkruimte kunnen nieuwe sleutels toevoegen. Als je een sleutel moet laten toevoegen, vraag het dan aan een eigenaar van de werkruimte.
Een opgeslagen sleutel gebruiken in Chat
Verwijs naar de opgeslagen sleutel in plaats van de waarde ervan in een bericht in te voeren.
- Open de project-Chat in de desktopversie van Atoms en typ
#. - Selecteer Sleutels.
- Zoek naar de opgeslagen sleutel en selecteer vervolgens de naam ervan.
- Vertel de Agent waarvoor de sleutel is en wat je wilt dat de integratie doet.
Het menu # voegt een verwijzing naar de opgeslagen sleutel toe zonder de waarde ervan in je bericht in te voegen.
Verwijs naar een opgeslagen sleutel in Chat
Een opgeslagen sleutel testen
- Voer in de App Viewer een eenvoudige actie uit die de sleutel gebruikt.
- Controleer of dit het verwachte resultaat oplevert, zoals het bezorgen van een test-e-mail of het retourneren van testgegevens.
- Controleer zichtbare fouten of logs en zorg ervoor dat ze de waarde van de sleutel niet blootstellen.
Als de service je aparte test- en live-sleutels geeft, gebruik dan de testsleutel terwijl je je app bouwt. Gebruik de live-sleutel pas nadat je app is gepubliceerd. Als de test mislukt, controleer dan het dashboard van de provider om te bevestigen dat de sleutel actief is en toestemming heeft om de gevraagde actie uit te voeren. Plak de waarde van de sleutel nooit in Chat tijdens het oplossen van problemen.
Begrijp hoe Sleutels werken
Voordat je sleutels toevoegt, is het handig om te begrijpen wat Atoms opslaat en hoe je je inloggegevens beschermt.
Wat Atoms opslaat
Atoms Cloud → Sleutels slaat inloggegevens op die je app gebruikt om verbinding te maken met externe services, zoals API-sleutels en toegangstokens.
Elke opgeslagen sleutel heeft een naam, beschrijving en privéwaarde. De naam en beschrijving helpen de Agent te begrijpen wanneer de sleutel moet worden gebruikt, terwijl de privéwaarde verborgen blijft voor Chat.
Waar je een sleutel kunt krijgen
Atoms maakt of levert geen inloggegevens voor externe services. Je moet deze verkrijgen van de relevante serviceprovider. Volg de instructies van de provider bij het kiezen van machtigingen, het testen van de sleutel en het controleren of deze verloopt.
Houd privé-inloggegevens geheim
Plak nooit privé-inloggegevens in Chat, broncode, code die in de browser draait, screenshots, logs of supportberichten. Sla ze op in Sleutels en verwijs vervolgens naar de opgeslagen invoer op naam.
Als een privéwaarde al is blootgesteld, beschouw deze dan als gecompromitteerd en trek deze in of roteer deze via de provider.
Privé- en browserveilige inloggegevens
Sleutels labelt opgeslagen waarden niet als Openbaar of Privé. Een waarde opslaan in Sleutels maakt deze niet automatisch veilig om te gebruiken in code die zichtbaar is voor de browser. Als je app de waarde in de browser gebruikt, kunnen bezoekers deze mogelijk inspecteren.
Controleer de documentatie van de provider voordat je beslist waar je een inloggegeven gebruikt:
- Gebruik een waarde in browsergerichte code alleen wanneer de provider expliciet aangeeft dat deze veilig kan worden blootgesteld.
- Bewaar privé-inloggegevens in server-side of backendlogica, waar ze niet worden blootgesteld aan app-bezoekers.
Kies de omgeving en opslag van de sleutel
Wanneer je een sleutel toevoegt, moet je twee afzonderlijke beslissingen nemen:
- Welke omgeving de sleutel zal gebruiken.
- Of de sleutel in dit project blijft of beschikbaar wordt voor andere projecten.
Kies een omgeving
Optie | Wanneer deze wordt gebruikt |
|---|---|
Testsleutels | Wordt gebruikt tijdens het ontwikkelen en testen van je app in de App Viewer. Als je geen aparte Productiewaarde toevoegt, gebruikt de gepubliceerde app ook de Testwaarde. |
Productiesleutels | Wordt gebruikt door de gepubliceerde app wanneer deze een aparte live-inloggegeven vereist. Productiewaarden worden toegevoegd tijdens het publicatieproces en afzonderlijk beheerd van Testwaarden. |
Kies waar je de sleutel opslaat
Optie | Wanneer je dit gebruikt |
|---|---|
In dit project | Kies dit voor een sleutel die alleen door het huidige project moet worden gebruikt. |
Sleutelbibliotheek | Kies dit wanneer je bewust een sleutel wilt hergebruiken in meerdere projecten. Wanneer je een Testsleutel toevoegt of bijwerkt, selecteer dan Opslaan in bibliotheek om deze beschikbaar te maken in de bibliotheek. |
De omgeving en opslaglocatie zijn onafhankelijk van elkaar. Een Testsleutel opslaan in de Sleutelbibliotheek maakt deze herbruikbaar, maar verandert deze niet in een Productiewaarde.
Gebruik standaard In dit project. Sla een sleutel alleen op in de bibliotheek wanneer je zeker weet dat deze tussen projecten gedeeld moet worden.
Een aparte Productiewaarde gebruiken
Wanneer je een project publiceert dat een opgeslagen sleutel gebruikt, kan de publicatiestroom je vragen om Productiesleutels te configureren. Standaard gebruikt de gepubliceerde app de Testwaarde. Om een ander inloggegeven te gebruiken, selecteer je Productie en sla je een aparte waarde op voor de sleutel.
Gebruik een aparte Productiewaarde wanneer:
- De provider verschillende test- en live-inloggegevens levert.
- Je niet wilt dat het inloggegeven dat tijdens de ontwikkeling wordt gebruikt, door de gepubliceerde app wordt gebruikt.
Productiewaarden worden aangemaakt via de publicatiestroom. Je kunt er geen maken door Nieuwe sleutel te selecteren op het tabblad Productiesleutels. Nadat een Productiewaarde is geconfigureerd voor een gepubliceerde app, kun je deze bekijken onder Atoms Cloud → Sleutels → Productiesleutels.
Na het publiceren of bijwerken van de app herhaal je de relevante gebruikersreis op de gepubliceerde website om te bevestigen dat de Productiesleutel correct werkt. Zie voor het volledige implementatieproces Publiceren en implementeren.
Een inloggegeven bijwerken of roteren
Een opgeslagen Testwaarde bijwerken
- Open Atoms Cloud → Sleutels → Testsleutels.
- Open In dit project of Sleutelbibliotheek, afhankelijk van waar de invoer is opgeslagen.
- Selecteer de Waarde of Beschrijving van de sleutel, voer de bijgewerkte informatie in en selecteer vervolgens Bijwerken.
- Wacht op Opslaan geslaagd en test daarna de betreffende stroom opnieuw.
Geplande sleutelrotatie
Volg deze stappen wanneer het bestaande inloggegeven nog steeds veilig is en je het wilt vervangen zonder je app te onderbreken:
- Maak een vervangend inloggegeven aan via de serviceprovider.
- Vervang de Testwaarde in Atoms en test vervolgens de betreffende functie in de App Viewer.
- Als de gepubliceerde app een aparte Productiewaarde gebruikt, vervang deze dan en publiceer de update.
- Test dezelfde functie op de gepubliceerde website.
- Nadat je hebt bevestigd dat de vervanging correct werkt, trek je het oude inloggegeven in via de provider.
Als een inloggegeven mogelijk is blootgesteld
Beschouw het inloggegeven als gecompromitteerd en handel onmiddellijk:
- Trek het in of schakel het uit via de serviceprovider.
- Maak een vervangend inloggegeven aan.
- Werk de relevante Test- en Productiewaarden in Atoms bij.
- Test de betreffende functies opnieuw in zowel de App Viewer als de gepubliceerde app.
- Verwijder waar mogelijk alle blootgestelde kopieën uit broncode, Chat, screenshots en logs.
Het verwijderen van een sleutel of het verwijderen van de waarde ervan uit Atoms trekt het oorspronkelijke inloggegeven niet in. Je moet het intrekken via de serviceprovider.
Een inloggegeven verwijderen
Voordat je een opgeslagen sleutel verwijdert, moet je ervoor zorgen dat je app er niet langer van afhankelijk is:
- Verwijder de functie die de sleutel gebruikt, of vervang de verwijzingen ernaar door een andere opgeslagen sleutel.
- Trek het oorspronkelijke inloggegeven in via de serviceprovider zodat het niet langer kan worden gebruikt.
- Open Atoms Cloud → Sleutels, zoek de inactieve invoer, selecteer Verwijderen en bevestig.
Het verwijderen van een sleutel kan niet ongedaan worden gemaakt. Het kan ook previews of oudere checkpoints breken die er nog steeds naar verwijzen. Als Verwijderen niet beschikbaar is, is de sleutel nog steeds als actief gemarkeerd. Verwijder of vervang elke verwijzing ernaar voordat je het opnieuw probeert.
FAQ
Mijn Testsleutel werkt in App Viewer maar niet na publicatie. Waarom?
Als je Testsleutel werkt in App Viewer maar de gepubliceerde app faalt omdat een sleutel ontbreekt of leeg is:
- Controleer of de relevante Test- of Productiewaarde vóór of na de laatste publicatie is opgeslagen. Als deze daarna is opgeslagen, publiceer dan opnieuw zodat de wijziging van kracht wordt.
- Controleer of de opgeslagen sleutel de juiste Test- of Productiewaarde heeft. De gepubliceerde app gebruikt de Testwaarde tenzij een aparte Productiewaarde is geconfigureerd.
- Controleer fouten van downstream-services op aanwijzingen. “Unauthorized” duidt vaak op een lege of onjuiste sleutel voor die omgeving.
Als het probleem aanhoudt, neem dan contact op met Support en voeg het volgende toe:
- Projectlink of live-URL
- De naam van de betreffende sleutel en of het probleem in de Test- of Productiewaarde zit
- De volledige fout van de downstream-service
- Een opgeschoonde screenshot van de configuratiepagina
- Of de sleutelconfiguratie vóór of na publicatie is opgeslagen
Belangrijk: Geef alleen sleutelnamen door. Stuur GEEN geheime waarden, wachtwoorden of tokens.