Referência da API
Referência da API
Referência completa de todos os endpoints da API LinkPix
Referência da API
Referência completa de todos os endpoints da API LinkPix. A API é RESTful, utiliza JSON para requests/responses e autenticação via Bearer Token.
Base URL
http://app.linkpix.co/api/v1Autenticação
Todas as requisições requerem autenticação via header Authorization:
Authorization: Bearer mbx_live_sua_chave_aqui
Content-Type: application/jsonEndpoints Disponíveis
👥 Clientes
Gerenciar clientes pessoa física e jurídica.
POST, GET, PATCH e DELETE para gerenciar clientes
📄 Faturas
Criar e gerenciar faturas com cálculo automático.
POST, GET, PATCH e DELETE para gerenciar faturas
💰 Orçamentos
Criar propostas e orçamentos profissionais.
POST, GET, PATCH e DELETE para gerenciar orçamentos
🔄 Faturas Recorrentes
Automatizar cobranças mensais e assinaturas.
POST, GET, PATCH e DELETE para gerenciar assinaturas
Formato das Respostas
Sucesso
{
"data": {
"id": "uuid",
"name": "exemplo"
},
"timestamp": "2026-01-12T10:30:00Z"
}Erro
{
"error": "Mensagem do erro",
"timestamp": "2026-01-12T10:30:00Z"
}Códigos HTTP
| Código | Descrição |
|---|---|
200 | OK - Requisição bem-sucedida |
201 | Created - Recurso criado |
400 | Bad Request - Parâmetros inválidos |
401 | Unauthorized - Falha na autenticação |
404 | Not Found - Recurso não encontrado |
500 | Internal Server Error - Erro interno |
Rate Limits
| Endpoint | Limite |
|---|---|
| Todos os endpoints | 100 req/min |
Exceder os limites resultará em resposta 429 Too Many Requests.