Sleutels en geheimen

Voordat je Sleutels gebruikt, verbind je het project met Atoms Cloud. Als het niet verbonden is, vraag de Agent dan om Atoms Cloud te verbinden of volg Atoms Cloud.

Een sleutel gebruiken in Atoms Cloud

Voordat je begint

Voordat je een sleutel toevoegt, zorg ervoor dat:

• Je Atoms gebruikt op desktopweb.
• Het project is verbonden met Atoms Cloud.
• Je een werkruimte-eigenaar bent. Alleen werkruimte-eigenaren 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 werkruimte-eigenaar bent. Als Atoms een bericht over plan- of gebruiksbeschikbaarheid toont, volg dan het beschikbaarheids- of upgradepad op het scherm en probeer het daarna opnieuw.

Een Testsleutel toevoegen

1. Open het project op een desktopapparaat.
2. Selecteer Atoms Cloud in dezelfde werkruimtewerkbalk waar de App Viewer staat.
3. Selecteer Sleutels in de zijbalk van Atoms Cloud.
4. Open Testsleutels en selecteer vervolgens In Dit Project.
5. Selecteer Nieuwe Sleutel.
6. Vul de vereiste 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 gegevens exact in zoals geleverd door de provider.
   • Beschrijving: Leg uit waarvoor de sleutel is, zoals Gebruikt om account-e-mails te verzenden. Neem de waarde van de gegevens niet op.
7. Als je de sleutel in andere projecten wilt hergebruiken, selecteer dan Opslaan in Bibliotheek.
8. Selecteer Toevoegen. Wanneer de sleutel is opgeslagen, toont Atoms Sleutel succesvol toegevoegd.

Een Testsleutel toevoegen

Alleen werkruimte-eigenaren kunnen nieuwe sleutels toevoegen. Als je een sleutel moet laten toevoegen, vraag het dan aan een werkruimte-eigenaar.

Een opgeslagen sleutel gebruiken in Chat

Verwijs naar de opgeslagen sleutel in plaats van de waarde ervan in een bericht in te voeren.

1. Open het project Chat in de desktopversie van Atoms en typ #.
2. Selecteer Sleutels.
3. Zoek naar de opgeslagen sleutel en selecteer vervolgens de naam ervan.
4. 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.

Verwijzen naar een opgeslagen sleutel in Chat

Een opgeslagen sleutel testen

1. Voer in de App Viewer een eenvoudige actie uit die de sleutel gebruikt.
2. Controleer of dit het verwachte resultaat oplevert, zoals het bezorgen van een test-e-mail of het retourneren van testgegevens.
3. 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.

Begrijpen hoe Sleutels werken

Voordat je sleutels toevoegt, is het nuttig om te begrijpen wat Atoms opslaat en hoe je je gegevens beschermt.

Wat Atoms opslaat

Atoms Cloud → Sleutels slaat gegevens 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 gegevens 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égegevens geheim

Plak nooit privégegevens in Chat, broncode, code die in de browser draait, screenshots, logs of supportberichten. Sla deze 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 gegevens

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 gegeven gebruikt:

• Gebruik een waarde alleen in code die zichtbaar is voor de browser wanneer de provider expliciet aangeeft dat deze veilig mag worden blootgesteld.
• Bewaar privégegevens 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 zal zijn voor andere projecten.

Kies een omgeving

Optie	Wanneer deze wordt gebruikt
Testsleutels	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	Gebruikt door de gepubliceerde app wanneer deze een aparte live-credential vereist. Productiewaarden worden toegevoegd tijdens het publicatieproces en afzonderlijk beheerd van Testwaarden.

Kies waar je de sleutel opslaat

Optie	Wanneer je deze 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 je Opslaan in Bibliotheek om deze beschikbaar te maken in de bibliotheek.

De omgeving en opslaglocatie staan los 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 als je zeker weet dat deze over projecten heen 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 andere credential te gebruiken, selecteer je Productie en sla je een aparte waarde voor de sleutel op.

Gebruik een aparte Productiewaarde wanneer:

• De provider verschillende test- en live-gegevens levert.
• Je niet wilt dat de gegevens die tijdens de ontwikkeling worden gebruikt, door de gepubliceerde app worden gebruikt.

Productiewaarden worden aangemaakt via de publicatiestroom. Je kunt er geen aanmaken 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.

Gegevens bijwerken of roteren

Een opgeslagen Testwaarde bijwerken

1. Open Atoms Cloud → Sleutels → Testsleutels.
2. Open In Dit Project of Sleutelbibliotheek, afhankelijk van waar de invoer is opgeslagen.
3. Selecteer de Waarde of Beschrijving van de sleutel, voer de bijgewerkte informatie in en selecteer vervolgens Bijwerken.
4. Wacht op Opslaan geslaagd en test daarna de betreffende flow opnieuw.

Geplande sleutelrotatie

Volg deze stappen wanneer de bestaande gegevens nog steeds veilig zijn en je deze wilt vervangen zonder je app te onderbreken:

1. Maak een vervangende credential aan via de serviceprovider.
2. Vervang de Testwaarde in Atoms en test vervolgens de betreffende functie in de App Viewer.
3. Als de gepubliceerde app een aparte Productiewaarde gebruikt, vervang deze dan en publiceer de update.
4. Test dezelfde functie op de gepubliceerde website.
5. Trek, nadat je hebt bevestigd dat de vervanging correct werkt, de oude gegevens in via de provider.

Als gegevens mogelijk zijn blootgesteld

Beschouw de gegevens als gecompromitteerd en handel onmiddellijk:

1. Trek deze in of schakel deze uit via de serviceprovider.
2. Maak vervangende gegevens aan.
3. Werk de relevante Test- en Productiewaarden in Atoms bij.
4. Test de betreffende functies opnieuw in zowel de App Viewer als de gepubliceerde app.
5. Verwijder waar mogelijk blootgestelde kopieën uit broncode, Chat, screenshots en logs.

Het verwijderen van een sleutel of het verwijderen van de waarde ervan uit Atoms trekt de oorspronkelijke gegevens niet in. Je moet deze intrekken via de serviceprovider.

Gegevens verwijderen

Voordat je een opgeslagen sleutel verwijdert, moet je ervoor zorgen dat je app er niet langer van afhankelijk is:

1. Verwijder de functie die de sleutel gebruikt, of vervang de verwijzingen ernaar door een andere opgeslagen sleutel.
2. Trek de oorspronkelijke gegevens in via de serviceprovider zodat deze niet langer kunnen worden gebruikt.
3. 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:

1. 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.
2. Controleer of de opgeslagen sleutel de juiste Test- of Productiewaarde heeft. De gepubliceerde app gebruikt de Testwaarde tenzij een aparte Productiewaarde is geconfigureerd.
3. 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 bij de Test- of Productiewaarde zit
• De volledige fout van de downstream-service
• Een geschoonde 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.