Nycklar och hemligheter
Lagra appens privata autentiseringsuppgifter i Atoms moln → Keys för att hålla deras värden borta från Chat och källkod, och för att hantera separata värden för Test och Production.
Lagra appens privata autentiseringsuppgifter i Atoms moln → Keys för att hålla deras värden borta från Chat och källkod, och för att hantera separata värden för Test och Production.
Innan du använder Keys ansluter du projektet till Atoms moln. Om det inte är anslutet, be Agent att ansluta Atoms moln eller följ Atoms moln.
Använd en nyckel i Atoms moln
Innan du börjar
Innan du lägger till en nyckel, säkerställ att:
- Du använder Atoms på webben på dator.
- Projektet är anslutet till Atoms moln.
- Du är arbetsytans ägare. Endast arbetsytans ägare kan lägga till nya nycklar.
Om Keys eller New Key inte är tillgängligt, bekräfta att du har öppnat det avsedda projektet och att det är anslutet till Atoms moln. Om New Key fortfarande inte är tillgängligt, bekräfta att du är arbetsytans ägare. Om Atoms visar ett meddelande om plan eller användningstillgänglighet, följ tillgänglighets- eller uppgraderingsflödet på skärmen och försök sedan igen.
Lägg till en Test-nyckel
- Öppna projektet på en stationär enhet.
- I samma verktygsfält för arbetsytan där App Viewer finns, välj Atoms moln.
- Välj Keys i sidofältet för Atoms moln.
- Öppna Test Keys och välj sedan In This Project.
- Välj New Key.
- Fyll i de obligatoriska fälten:
- Name: Ange ett tydligt referensnamn, till exempel RESEND_API_KEY. Använd bokstäver, siffror och understreck, och börja med en bokstav eller ett understreck.
- Value: Ange autentiseringsuppgiften exakt som den tillhandahålls av leverantören.
- Description: Förklara vad nyckeln används till, till exempel Används för att skicka konto-e-post. Inkludera inte autentiseringsuppgiftens värde.
- Om du vill återanvända nyckeln i andra projekt, välj Save to Library.
- Välj Add. När nyckeln har sparats visar Atoms Key added successfully.
Lägg till en Test-nyckel
Endast arbetsytans ägare kan lägga till nya nycklar. Om du behöver få en nyckel tillagd, be en ägare av arbetsytan.
Använd en sparad nyckel i Chat
Referera till den sparade nyckeln i stället för att ange dess värde i ett meddelande.
- Öppna projektets Chat i skrivbordsversionen av Atoms och skriv
#. - Välj Keys.
- Sök efter den sparade nyckeln och välj sedan dess namn.
- Berätta för Agent vad nyckeln är till för och vad du vill att integrationen ska göra.
Menyn # lägger till en referens till den sparade nyckeln utan att infoga dess värde i ditt meddelande.
Referera till en sparad nyckel i Chat
Testa en sparad nyckel
- Utför en enkel åtgärd i App Viewer som använder nyckeln.
- Bekräfta att den ger det förväntade resultatet, till exempel att ett testmejl levereras eller att testdata returneras.
- Granska eventuella synliga fel eller loggar och säkerställ att de inte exponerar nyckelns värde.
Om tjänsten ger dig separata test- och live-nycklar, använd testnyckeln medan du bygger appen. Använd live-nyckeln först efter att appen har publicerats. Om testet misslyckas, kontrollera leverantörens instrumentpanel för att bekräfta att nyckeln är aktiv och har behörighet att utföra den begärda åtgärden. Klistra aldrig in nyckelns värde i Chat vid felsökning.
Förstå hur Keys fungerar
Innan du lägger till nycklar är det bra att förstå vad Atoms lagrar och hur du skyddar dina autentiseringsuppgifter.
Vad Atoms lagrar
Atoms moln → Keys lagrar autentiseringsuppgifter som appen använder för att ansluta till externa tjänster, till exempel API-nycklar och åtkomsttoken.
Varje sparad nyckel har ett namn, en beskrivning och ett privat värde. Namnet och beskrivningen hjälper Agent att förstå när nyckeln ska användas, medan det privata värdet förblir dolt från Chat.
Var du får en nyckel
Atoms skapar eller tillhandahåller inte autentiseringsuppgifter för externa tjänster. Du måste hämta dem från den relevanta tjänsteleverantören. Följ leverantörens instruktioner när du väljer behörigheter, testar nyckeln och kontrollerar om den löper ut.
Håll privata autentiseringsuppgifter hemliga
Klistra aldrig in en privat autentiseringsuppgift i Chat, källkod, kod som körs i webbläsaren, skärmbilder, loggar eller supportmeddelanden. Spara den i Keys och referera sedan till den sparade posten med namn.
Om ett privat värde redan har exponerats, behandla det som komprometterat och återkalla eller rotera det via leverantören.
Privata autentiseringsuppgifter och autentiseringsuppgifter som är säkra för webbläsaren
Keys märker inte sparade värden som Public eller Private. Att spara ett värde i Keys gör det inte automatiskt säkert att använda i kod som exponeras mot webbläsaren. Om appen använder värdet i webbläsaren kan besökare kanske inspektera det.
Kontrollera leverantörens dokumentation innan du bestämmer var en autentiseringsuppgift ska användas:
- Använd ett värde i kod som exponeras mot webbläsaren endast när leverantören uttryckligen anger att det är säkert att exponera.
- Behåll privata autentiseringsuppgifter i serverlogik eller backendlogik, där de inte exponeras för appens besökare.
Välj nyckelns miljö och lagring
När du lägger till en nyckel behöver du fatta två separata beslut:
- Vilken miljö som ska använda nyckeln.
- Om nyckeln ska stanna i det här projektet eller vara tillgänglig för andra projekt.
Välj en miljö
Alternativ | När det används |
|---|---|
Test Keys | Används när du utvecklar och testar appen i App Viewer. Om du inte lägger till ett separat Production-värde kommer den publicerade appen också att använda Test-värdet. |
Production Keys | Används av den publicerade appen när den kräver en separat live-autentiseringsuppgift. Production-värden läggs till under publiceringsprocessen och hanteras separat från Test-värden. |
Välj var nyckeln ska sparas
Alternativ | När du ska använda det |
|---|---|
In This Project | Välj detta för en nyckel som endast ska användas av det aktuella projektet. |
Key Library | Välj detta när du avsiktligt vill återanvända en nyckel i flera projekt. När du lägger till eller uppdaterar en Test-nyckel väljer du Save to Library för att göra den tillgänglig i biblioteket. |
Miljön och lagringsplatsen är oberoende av varandra. Att spara en Test-nyckel i Key Library gör den återanvändbar, men det gör den inte till ett Production-värde.
Använd In This Project som standard. Spara en nyckel i biblioteket endast när du är säker på att den ska delas mellan projekt.
Använd ett separat Production-värde
När du publicerar ett projekt som använder en sparad nyckel kan publiceringsflödet be dig att konfigurera Production Keys. Som standard använder den publicerade appen Test-värdet. För att använda en annan autentiseringsuppgift väljer du Production och sparar ett separat värde för nyckeln.
Använd ett separat Production-värde när:
- Leverantören tillhandahåller olika test- och live-autentiseringsuppgifter.
- Du inte vill att autentiseringsuppgiften som används under utvecklingen ska användas av den publicerade appen.
Production-värden skapas via publiceringsflödet. Du kan inte skapa ett genom att välja New Key från fliken Production Keys. Efter att ett Production-värde har konfigurerats för en publicerad app kan du visa det under Atoms moln → Keys → Production Keys.
Efter att du har publicerat eller uppdaterat appen, upprepa den relevanta användarresan på den publicerade webbplatsen för att bekräfta att Production-nyckeln fungerar korrekt. För den fullständiga distributionsprocessen, se Publicera och distribuera.
Uppdatera eller rotera en autentiseringsuppgift
Uppdatera ett sparat Test-värde
- Öppna Atoms moln → Keys → Test Keys.
- Öppna In This Project eller Key Library, beroende på var posten sparades.
- Välj nyckelns Value eller Description, ange den uppdaterade informationen och välj sedan Update.
- Vänta på Save success och testa sedan det berörda flödet igen.
Planerad nyckelrotation
Följ dessa steg när den befintliga autentiseringsuppgiften fortfarande är säker och du vill ersätta den utan att avbryta appen:
- Skapa en ersättningsautentiseringsuppgift via tjänsteleverantören.
- Ersätt Test-värdet i Atoms och testa sedan den berörda funktionen i App Viewer.
- Om den publicerade appen använder ett separat Production-värde, ersätt det och publicera uppdateringen.
- Testa samma funktion på den publicerade webbplatsen.
- När du har bekräftat att ersättningen fungerar korrekt, återkalla den gamla autentiseringsuppgiften via leverantören.
Om en autentiseringsuppgift kan ha exponerats
Behandla autentiseringsuppgiften som komprometterad och agera omedelbart:
- Återkalla eller inaktivera den via tjänsteleverantören.
- Skapa en ersättningsautentiseringsuppgift.
- Uppdatera relevanta Test- och Production-värden i Atoms.
- Testa de berörda funktionerna igen i både App Viewer och den publicerade appen.
- Ta bort alla exponerade kopior från källkod, Chat, skärmbilder och loggar där det är möjligt.
Att ta bort en nyckel eller ta bort dess värde från Atoms återkallar inte den ursprungliga autentiseringsuppgiften. Du måste återkalla den via tjänsteleverantören.
Ta bort en autentiseringsuppgift
Innan du tar bort en sparad nyckel, säkerställ att appen inte längre är beroende av den:
- Ta bort funktionen som använder nyckeln, eller ersätt dess referenser med en annan sparad nyckel.
- Återkalla den ursprungliga autentiseringsuppgiften via tjänsteleverantören så att den inte längre kan användas.
- Öppna Atoms moln → Keys, hitta den inaktiva posten, välj Delete och bekräfta.
Att ta bort en nyckel kan inte ångras. Det kan också göra att förhandsvisningar eller äldre kontrollpunkter som fortfarande refererar till den slutar fungera. Om Delete inte är tillgängligt är nyckeln fortfarande markerad som aktiv. Ta bort eller ersätt varje referens till den innan du försöker igen.
Vanliga frågor
Min Test-nyckel fungerar i App Viewer men inte efter publicering. Varför?
Om din Test-nyckel fungerar i App Viewer men den publicerade appen misslyckas eftersom en nyckel saknas eller är tom:
- Kontrollera om det relevanta Test- eller Production-värdet sparades före eller efter den senaste publiceringen. Om det sparades efteråt, publicera igen för att ändringen ska träda i kraft.
- Verifiera att den sparade nyckeln har rätt Test- eller Production-värde. Den publicerade appen använder Test-värdet om inte ett separat Production-värde är konfigurerat.
- Granska fel från nedströms tjänster för ledtrådar. ”Unauthorized” indikerar ofta en tom eller felaktig nyckel för den miljön.
Om problemet kvarstår, kontakta Support och inkludera:
- Projektlänk eller live-URL
- Namnet på den berörda nyckeln och om problemet gäller Test- eller Production-värdet
- Det fullständiga felet från den nedströms tjänsten
- En sanerad skärmbild av konfigurationssidan
- Om nyckelkonfigurationen sparades före eller efter publicering
Viktigt: Ange endast nyckelnamn. Skicka INTE hemliga värden, lösenord eller token.