Din PushEngage API-nyckel autentiserar API-förfrågningar för en webbplats, så allt som anropar PushEngage API använder den. Du kan visa, kopiera och generera om nyckeln från dina webbplatsinställningar, och varje webbplats har sin egen nyckel. Den här guiden visar dig hur du hittar din API-nyckel och hur du roterar den säkert.
Innan du börjar
- Du måste vara inloggad på PushEngage-instrumentpanelen med åtkomst till webbplatsen du vill hantera.
- Att generera om nyckeln ersätter omedelbart den gamla. Alla integrationer som fortfarande använder den gamla nyckeln slutar fungera tills du uppdaterar dem med den nya nyckeln, så planera att uppdatera dina integrationer direkt efter att du roterar.
- API-nyckeln är specifik för en webbplats. Om du hanterar mer än en webbplats, byt till rätt webbplats först.
Var du hittar din API-nyckel
På PushEngage-instrumentpanelen, gå till Webbplatsinställningar » Webbplatsdetaljer och bläddra ner till avsnittet API-nyckel.
Generera din första API-nyckel
Om webbplatsen ännu inte har en API-nyckel, klicka på Generera en ny API-nyckel. PushEngage skapar nyckeln och bekräftar med "API-nyckel genererad framgångsrikt."
Kopiera din API-nyckel
När en nyckel finns visas den maskerad för säkerhets skull. Klicka på Kopiera för att kopiera hela nyckeln till ditt urklipp, klistra sedan in den där den behövs. Nyckeln visas alltid maskerad på skärmen, så använd Kopiera istället för att försöka läsa den.
Rotera (generera om) din API-nyckel
Att rotera nyckeln ersätter den med en ny, vilket är rätt åtgärd om nyckeln kan ha exponerats, eller som periodisk hygien.
- I avsnittet API-nyckel, klicka på Generera om API-nyckel.
- I bekräftelseprompten, "Vill du generera om API-nyckeln?", klicka på Ja, generera om.
- PushEngage utfärdar en ny nyckel och bekräftar att den har genererats.
- Kopiera den nya nyckeln och uppdatera alla integrationer som använde den gamla.
Vanliga frågor
Kommer omgenerering av nyckeln att bryta mina integrationer?
Ja, tills du uppdaterar dem. Den gamla nyckeln slutar fungera i samma ögonblick som du genererar om den, så alla appar, plugins eller skript som använder den kommer att misslyckas tills du ersätter den med den nya nyckeln. Rotera vid en tidpunkt då du kan uppdatera dina integrationer omedelbart.
Är API-nyckeln densamma för alla mina webbplatser?
Nej. Varje webbplats har sin egen API-nyckel. Om du hanterar flera webbplatser, se till att du är på rätt webbplats innan du kopierar eller genererar om en nyckel.
Varför kan jag bara se en maskerad nyckel?
Nyckeln visas maskerad på skärmen för säkerhets skull. Använd knappen Kopiera för att kopiera hela nyckeln till ditt urklipp.
När ska jag rotera min API-nyckel?
Rotera den om du tror att nyckeln har exponerats, när någon med åtkomst till den slutar, eller enligt ett regelbundet schema som god säkerhetspraxis. Kom ihåg att uppdatera dina integrationer med den nya nyckeln varje gång.
Om du stöter på några problem är du välkommen att kontakta oss genom att klicka här. Vårt supportteam kommer att kunna hjälpa dig.