Documentação da API

Bem-vindo à documentação oficial da API do Aprovei Checkout. Aqui você encontrará todas as informações necessárias para integrar seu sistema com nossa plataforma.

Versão da API: Atualmente estamos na versão 2.0 da nossa API. Para garantir compatibilidade, sempre especifique a versão em suas requisições.

O que você pode fazer com nossa API?

Criar Cobranças PIX

Gere cobranças via PIX de forma programática para suas vendas.

Webhooks

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

Gestão Completa

Gerencie produtos, pedidos e clientes através da API.

Começando

1. Obtenha sua API Key

Para usar a API, você precisa de uma chave de autenticação. Faça login no sistema e acesse:

URL

https://app.aproveicheckout.com.br/conta/api-keys

2. Configure suas Requisições

Todas as requisições devem incluir sua API Key no header:

HTTP Header

api-key: SUA_API_KEY_AQUI

3. Faça sua Primeira Requisição

Teste a conexão com nossa API:

cURL

curl --location 'https://app.aproveicheckout.com.br/api/status' \
--header 'api-key: SUA_API_KEY_AQUI'

Resposta de Sucesso:

{
  "status": "success",
  "message": "API funcionando corretamente",
  "version": "2.0"
}

URLs Base

Ambiente	URL Base
Produção	`https://app.aproveicheckout.com.br/api`

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`	API Key inválida ou ausente
`404 Not Found`	Recurso não encontrado
`422 Unprocessable Entity`	Erro de validação
`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

API PIX

Criar cobranças via PIX

Webhooks

Notificações em tempo real

Precisa de Ajuda?
Se você tiver dúvidas ou encontrar algum problema, entre em contato com nosso suporte através do e-mail: suporte{{ parse_url(config('app.url'), PHP_URL_HOST) }}