Codex · III

Chaves de API

As chaves de API permitem que você chame os endpoints de checkout e status a partir do seu próprio código, sem o botão de compra. Você só precisa de uma se estiver construindo seu próprio checkout ou integração de servidor; se estiver colando o botão de compra, você pode pular isso inteiramente.

Quando você precisa de uma chave

O botão de compra funciona sem nenhuma chave — ele fala com endpoints públicos e com escopo de projeto. Uma chave é para o outro caminho: chamadas que você faz a partir do seu próprio servidor, onde você cria um checkout ou lê o status de uma transação em código. As chaves vivem sob a aba Chaves de API do seu projeto.

A aba Chaves de API. Vazia até você criar sua primeira chave.

Crie uma chave

Clique em Criar chave, dê a ela um nome que você reconhecerá depois — geralmente onde ela roda, como "Servidor de produção" — e clique em Gerar chave. O nome é apenas um rótulo para você; não muda o que a chave pode fazer (uma chave é escopo deste projeto).

Nomeie a chave para onde ela vai viver, depois a gere.

Copie-a uma vez

A chave é mostrada uma vez, logo depois que você a gera. Começa com cmk_. Copie-a agora e armazene-a em algum lugar seguro — mantemos apenas um hash, então não podemos mostrá-la a você novamente. Perca-a e você simplesmente cria uma nova e deleta a antiga.

Esta é a única vez que a chave completa é mostrada. Copie-a antes de fechar.

Trate a chave como uma senha. Use-a apenas a partir de código do lado do servidor, envie-a no cabeçalho Authorization como um token bearer, e nunca a coloque em uma página web, em um repositório público, ou em qualquer coisa que seja enviada para o navegador de um comprador. Qualquer um com a chave pode agir pelo seu projeto.

Use, liste e revogue

As chaves salvas são listadas por nome, um prefixo mascarado e a data criada. Você nunca vê a chave completa novamente — o prefixo é apenas suficiente para distingui-las. O ícone de lixo revoga uma chave imediatamente: qualquer código ainda a usando começa a ser rejeitado, então rotacione criando a nova chave primeiro, implantando-a, depois deletando a antiga.

Cada chave mostra um prefixo mascarado e uma data criada; o ícone de lixo a revoga.

Para o que você pode chamar com a chave — criando um checkout do seu próprio código, tratando eventos e pesquisando status — veja Usando a API.

Pronto para conectar?

O plano gratuito cobre a maioria dos sites e nunca pede cartão.