Skip to main content

POST /v1/api-keys

Cria uma nova API Key vinculada ao seu merchant. A key é gerada com o prefixo lk_ e pode ser usada no header Authorization: Bearer em qualquer rota que aceite autenticação.
Esta rota requer autenticação via JWT. Não é possível usar uma API Key para criar outra API Key.

Request

POST https://api.liquera.com.br/v1/api-keys
Authorization: Bearer <seu_jwt>
Content-Type: application/json

Body

name
string
required
Nome identificador da API Key. Use nomes descritivos como "Produção", "Integração ERP" ou "Checkout Site".
description
string
required
Descrição do propósito desta key. Ajuda a identificar onde ela está sendo usada caso precise revogar.

Exemplo

curl -X POST https://api.liquera.com.br/v1/api-keys \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Produção",
    "description": "API Key do servidor de checkout em produção"
  }'

Response

apiKey
object
Dados da API Key criada.
{
  "apiKey": {
    "id": "clx2def456",
    "name": "Produção",
    "description": "API Key do servidor de checkout em produção",
    "value": "lk_4f8a2b9c1d3e5f7a8b9c0d1e2f3a4b5c",
    "status": "ACTIVE",
    "createdAt": "2025-01-15T10:30:00.000Z"
  }
}

O value é exibido uma única vez. Após fechar esta resposta, não é possível recuperá-lo. Se perder a key, delete-a e crie uma nova.

Como usar a API Key

Após salvar o value, use-o exatamente como usaria um JWT:
# Criar uma cobrança com API Key
curl -X POST https://api.liquera.com.br/v1/charges \
  -H "Authorization: Bearer lk_4f8a2b9c1d3e5f7a8b9c0d1e2f3a4b5c" \
  -H "Content-Type: application/json" \
  -d '{ "amount": 9990, "description": "Pedido #1234" }'
// Node.js — armazene em variável de ambiente
const response = await fetch('https://api.liquera.com.br/v1/charges', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.LIQUERA_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ amount: 9990, description: 'Pedido #1234' }),
});

Boas práticas

  • Crie uma API Key separada por ambiente (desenvolvimento, staging, produção)
  • Crie uma API Key separada por sistema integrado (ERP, e-commerce, etc.)
  • Nunca compartilhe a mesma key entre sistemas diferentes — assim você pode revogar uma sem afetar as outras
  • Guarde o value como variável de ambiente, nunca no código-fonte