Codex · III

API-sleutels

API-sleutels laten je checkout- en statusindienten aanroepen vanuit je eigen code, zonder de buy button. Je hebt er maar één nodig als je je eigen afrekening of serverintegratie bouwt; als je de buy button plakt, kun je dit geheel overslaan.

Wanneer je een sleutel nodig hebt

De buy button werkt helemaal zonder sleutel — het spreekt openbare, projectgebonden eindpunten aan. Een sleutel is voor het andere pad: oproepen die je van je eigen server doet, waar je een afrekening maakt of de status van een transactie in code leest. Sleutels bevinden zich onder je project API-sleutels tabblad.

Het tabblad API-sleutels. Leeg totdat je je eerste sleutel maakt.

Een sleutel maken

Klik op Sleutel maken, geef het een naam die je later kunt herkennen — meestal waar het loopt, zoals "Production server" — en klik op Sleutel genereren. De naam is slechts een label voor jou; het verandert niets aan wat de sleutel kan doen (een sleutel is bereikt voor dit project).

Noem de sleutel voor waar hij leeft, genereer hem vervolgens.

Kopieer het eenmaal

De sleutel wordt eenmaal weergegeven, direct nadat je hem hebt gegenereerd. Het begint met cmk_. Kopieer het nu en sla het ergens veilig op — we bewaren alleen een hash, dus we kunnen het je niet opnieuw tonen. Verlies het en je maakt gewoon een nieuw en verwijdert het oude.

Dit is de enige keer dat de volledige sleutel wordt weergegeven. Kopieer deze voordat je sluit.

Behandel de sleutel als een wachtwoord. Gebruik het alleen vanuit servercode, stuur het in de autorisatie header als dragertoken en plaats het nooit op een webpagina, een openbare repo of iets dat naar een kopersbrowser gaat. Iedereen met de sleutel kan namens je project handelen.

Gebruiken, oplijsten en intrekken

Opgeslagen sleutels worden vermeld op naam, een gemaskeerd voorvoegsel en de datum waarop ze zijn gemaakt. Je ziet de volledige sleutel nooit meer — het voorvoegsel is net genoeg om ze uit elkaar te houden. Het prullenbakpictogram trekt een sleutel onmiddellijk in: elke code die er nog steeds gebruik van maakt, begint te worden geweigerd, dus roteer door eerst de nieuwe sleutel te maken, deze uit te rollen en vervolgens de oude te verwijderen.

Elke sleutel toont een gemaskeerd voorvoegsel en een gemaakte datum; het prullenbakpictogram trekt het in.

Voor wat je met de sleutel kunt aanroepen — het maken van een afrekening vanuit je eigen code, het verwerken van gebeurtenissen en het pollen van status — zie De API gebruiken.

Klaar om het te bedraden?

Het gratis abonnement dekt de meeste sites en vraagt nooit om een kaart.