Chaves API

Programadores

As chaves que os seus servidores apresentam para chamar a API. É aqui que são emitidas, renovadas e revogadas.

Teste e produção

Uma chave de teste (sk_test_…) percorre toda a plataforma sem que se mova dinheiro: é a primeira chave certa para qualquer integração. Ver também Loja de teste e o guia Para começar.

Um segredo é mostrado uma só vez

A chave é mostrada na criação e nunca mais pode ser recuperada. Guarde-a em segurança de imediato. Se se perder não há recuperação — há renovação.

A assinatura dos pedidos

Marcar Exigir assinatura gera um segredo de assinatura dedicado, mostrado também uma só vez. Cada pedido com essa chave deve então apresentar:

X-NeoPays-Signature: t=<unix>,v1=<hex HMAC-SHA256(signing secret, t + "." + body)>

É definitivo para essa chave. Para deixar de assinar é preciso emitir uma chave nova.

Renovar em vez de revogar

Renovar emite a chave nova de imediato e deixa a antiga viver durante um período de graça, o tempo de implantar sem interrupção. É pedido um código de confirmação, e só autoriza essa renovação.

Uma graça de zero dias corta a chave antiga assim que confirmar — qualquer integração que ainda a use para nesse instante.

Revogar é imediato e sem graça.

Os âmbitos

Uma chave traz apenas os direitos que lhe der: iniciar pagamentos, ler transações, pagar, reembolsar, gerir webhooks, ler ou registar clientes finais. Dê-lhe o mínimo de que a sua integração precisa.

— /dashboard/api-keys