Codex · III

API-nycklar

API-nycklar låter dig anropa checkout- och statusslutpunkterna från din egen kod, utan köpknappen. Du behöver bara en om du bygger din egen checkout eller serverintegrering; om du klistrar in köpknappen kan du hoppa över detta helt.

När du behöver en nyckel

Köpknappen fungerar utan någon nyckel alls — den talar med offentliga, projektomfattade slutpunkter. En nyckel är för den andra vägen: anrop du gör från din egen server, där du skapar en checkout eller läser en transaktionstatus i kod. Nycklar finns under ditt projekts API-nycklar-flik.

Fliken API-nycklar. Tom tills du skapar din första nyckel.

Skapa en nyckel

Klicka på Skapa nyckel, ge den ett namn du känner igen senare — vanligtvis där den körs, som "Produktionsserver" — och klicka på Generera nyckel. Namnet är bara en etikett för dig; det ändrar inte vad nyckeln kan göra (en nyckel är omfattad av detta projekt).

Namnge nyckeln för var den ska bo, sedan generera den.

Kopiera det en gång

Nyckeln visas en gång, direkt efter att du genererat den. Den börjar med cmk_. Kopiera den nu och lagra den någonstans säkert — vi behåller bara en hash, så vi kan inte visa det för dig igen. Förlora det och du skapar helt enkelt en ny och tar bort den gamla.

Det här är enda gången hela nyckeln visas. Kopiera den innan du stänger.

Behandla nyckeln som ett lösenord. Använd den bara från serverkodutsida, skicka den i Authorization-rubriken som en innehavartoken, och placera aldrig den på en webbsida, ett offentligt arkiv eller något som skickas till en köpares webbläsare. Vem som helst med nyckeln kan agera för ditt projekt.

Använd, lista och återkalla

Sparade nycklar listas efter namn, en maskerad prefix och det datum som skapades. Du ser aldrig hela nyckeln igen — prefixet är bara nog för att skilja dem åt. Papperskorgsikonen återkallar en nyckel omedelbar: all kod som fortfarande använder den börjar få avslag, så rotera genom att skapa den nya nyckeln först, distribuera den, sedan ta bort den gamla.

Varje nyckel visar en maskerad prefix och ett skapat datum; papperskorgsikonen återkallar den.

För vad du kan anropa med nyckeln — att skapa en checkout från din egen kod, hantera händelser och avsöka status — se Använda API:et.

Redo att koppla in det?

Gratisnivån täcker de flesta webbplatser och ber aldrig om ett kort.