Documentação da API Aprovei

Bem-vindo à documentação oficial da API Aprovei. Aqui você encontrará as informações necessárias para integrar catálogo, checkout, PIX, webhooks e agentes de IA com nossa plataforma.

Uma API, uma autenticação: use sua API Key com Authorization: Bearer e X-Store-Slug em todos os endpoints da base https://api.aproveicheckout.com.br/v1.

O que você pode fazer com nossa API?

Storefront e Checkout

Consulte a loja e o catálogo e crie checkouts de forma programática com a API Aprovei.

Criar Cobranças PIX

Gere cobranças via PIX em POST /v1/pix.

Webhooks

Receba notificações em tempo real sobre vendas e atualizações.

Segurança

Autenticação por token com restrição opcional por IP para máxima proteção.

Começando

1. Obtenha sua API Key

Para usar a API, faça login no painel, clique no avatar/menu do usuário no canto superior direito e acesse API Keys.

URL

https://app.aproveicheckout.com.br/user/api-tokens

2. Configure suas requisições

Envie a API Key como Bearer e informe a loja alvo em X-Store-Slug. Veja os detalhes na página de Autenticação.

HTTP Headers

Authorization: Bearer SEU_TOKEN
X-Store-Slug: SLUG_DA_LOJA
Content-Type: application/json

3. Faça sua Primeira Requisição

Consulte os dados públicos da sua loja na API Aprovei:

cURL

curl --location 'https://api.aproveicheckout.com.br/v1/store' \
--header 'Authorization: Bearer SEU_TOKEN' \
--header 'X-Store-Slug: SLUG_DA_LOJA'

Resposta de Sucesso: um objeto store com os dados públicos da loja (nome, slug, domínio de vendas, moeda e idioma). Veja o detalhe do endpoint em GET /store.

URL base

Área	URL Base	Autenticação
Catálogo e checkout	`https://api.aproveicheckout.com.br/v1`	`Authorization: Bearer` + `X-Store-Slug`
PIX	`https://api.aproveicheckout.com.br/v1`	`Authorization: Bearer` + `X-Store-Slug`

Códigos de Status HTTP

Código	Descrição
`200 OK`	Requisição bem-sucedida
`201 Created`	Recurso criado com sucesso
`400 Bad Request`	Erro nos parâmetros enviados
`401 Unauthorized`	Token inválido ou ausente
`403 Forbidden`	Token sem permissão ou IP não autorizado
`404 Not Found`	Recurso não encontrado
`409 Conflict`	Conflito de idempotência (API v1)
`415 Unsupported Media Type`	`Content-Type: application/json` ausente em POST (API v1)
`422 Unprocessable Entity`	Erro de validação
`429 Too Many Requests`	Limite de requisições excedido
`500 Internal Server Error`	Erro interno do servidor

Próximos Passos

Agora que você conhece o básico, explore nossa documentação:

Autenticação

Aprenda como usar API Keys

Loja e Catálogo

Consulte a loja, produtos e busca

Checkout

Crie o link de checkout

PIX

Crie cobranças via PIX

Webhooks

Notificações em tempo real

Precisa de Ajuda?
Se você tiver dúvidas ou encontrar algum problema, acesse nossa central de ajuda: Acessar FAQ