Hur man skapar REST API-nycklar i Braze

Att föra samman olika system och funktioner är på ett eller annat sätt avgörande för alla marknadsteam och Braze gör detta enklare genom sina kraftfulla REST APIs. Till exempel kan du behöva skapa en REST API-nyckel för att integrera Braze med ditt CRM-system eller massuppdatera användare i systemet.

Men innan du kan utnyttja APIs måste du skapa en API-nyckel. Denna guide visar dig hur.

Häng med så kommer du att vara redo att skapa API-nycklar i Braze och säkert koppla ihop vad du nu behöver.

Hur man gör

Steg 1: Hitta till API-inställningar

Första steget för att skapa en REST API-nyckel i Braze är att hitta rätt i menyn.

‍

‍

• Navigera till Settings. Du hittar den i menyn längst ned  till vänster.
• Välj APIs and Identifiers. Klicka på APIs and Identifiers. Det är här du skapar och hanterar API-nycklar.
• OBS: Om du fortfarande använder den äldre navigeringen, gå till Developer Console > API Settings.

‍

Steg 2: Skapa en ny API-nyckel

När du är inne i API-inställningarna kan du fortsätta med att skapa en ny API-nyckel.

‍

‍

• Klicka på "Create API Key: Du kommer att se knappen “Create API Key” längst upp till höger. Klicka på den för att börja skapa nyckeln.
• Ge din API-nyckel ett namn: Ge API-nyckeln ett beskrivande namn, exempelvis “Campaign Engagement Data” eller “Data Export Key”. Som vanlig hjälper ett tydligt namn dig och andra att förstå och enkelt navigera i systemet.
• Ange Allowlisted IP-adresser och Subnet: Om det behövs, ange de IP-adresser eller subnät som ska ha åtkomst till API-nyckeln. Att allowlista IP-adresser innebär att endast specifika IP-adresser kan använda den. Detta är viktigt om du vill säkerställa att endast betrodda nätverk, som din företagserver, kan komma åt APIn. När du väl har skapat en API-nyckel kan du inte ändra allowlisted IPs eller behörigheter. Så om du senare vill ändra dessa måste du skapa en ny nyckel och ersätta den gamla.

‍

Steg 3: Definiera behörigheter

Nästa steg är att definiera behörigheterna för API-nyckeln. Detta görs i samma meny som de tidigare stegen.

‍

^ Tillgängliga kategorier av permissions. Du kan expandera dessa för att se alla specifika permissions och samt förklaring.

‍

• Tilldela behörigheter baserat på krav: På samma sida kan du också tilldela behörigheter. Alltså  vilken åtkomst till systemets delar och funktioner API-nyckeln ska ha. Välj behörigheter såsom users.track eller users-delete, beroende på vilka funktioner nyckeln ska ha tillgång till. Du kan läsa mer om vad alla dessa betyder här.
• Använd principen om “least privilege”: Tilldela endast de behörigheter som behövs för uppgiften. Detta minskar risken ifall en nyckel skulle komma på vift. Varför? Tänk dig det här: Istället för att du tappat en nyckel som låser upp alla rum i ditt hus så har du bara tappat nyckeln till toaletten i källaren. Med andra ord hade det kunnat varit värre nu när olyckan var framme. 
• Viktigt: Efter att en ny API-nyckel har skapats kan du inte ändra behörigheter eller allowlisted IPs. Om ändringar behövs, skapa en ny nyckel med nya behörigheter och ersätt den gamla. Radera sen den gamla nyckeln.‍
• Klicka på "Save:”: Efter att du har valt behörigheterna, klicka på Save. REST API-nyckeln kommer nu att vara tillgänglig under Identifier och ser ut t.ex så här “abc123gh-5678-9ijk-lmno-pqrs90tu1234”

‍

Steg 5: Integrera din API-nyckel med din applikation

Slutligen kan du använda den nyss skapade API-nyckeln i din önskade applikation eller integration.

‍

Tips och “best practice”

Tips 1: Använd en beskrivande namngivningskonvention

För att undvika förvirring i framtiden, använd en konsekvent “naming convention” för dina API-nycklar som in. Som vanligt när du skapar en “naming convention” - se till att involvera alla som kommer arbeta med den i processen, förankra den och underhåll den.

Tips 2: Granska behörigheter regelbundet

Granska regelbundet de behörigheter som är kopplade till dina API-nycklar för att säkerställa att de överensstämmer med aktuella behov. Ta bort nycklar som inte används och ha översikt så andra användare ej skapar nycklar med för breda behörigheter.

‍

Behöver du hjälp?

Nu när du vet hur du skapar API-nycklar i Braze kan du börja integrera dina applikationer och göra verklighet av det där fantastiska caset du har planerat. 

Om du har frågor eller behöver hjälp är du varmt välkommen att kontakta mig och Leadfront. Som oberoende experter finns vi här för att hjälpa dig att maximera effekten av Braze (och andra system) i din digitala marknadsföring. 

‍

Ha det bra!