# Visão geral

Base URL, autenticação e formato das respostas.

A API da VibeCash reúne cobranças PIX, envios, devoluções, transferências internas, carteira, programações e webhooks em uma única integração.

## Base URL

```
https://seu-dominio/v1
```

## Autenticação (API key)

Crie a credencial em [Integrações → API](/docs/pages/guides/authentication) no painel. Para cada chamada, envie os headers abaixo.

```
X-API-Key: tp_live_SUA_CHAVE
Content-Type: application/json
```

O servidor também aceita o formato Bearer para a chave VibeCash. Credencial inválida retorna `401`; ausência de permissão retorna `403`.

## Envelope de resposta

Uma resposta de sucesso traz os dados da operação em `data`.

```
{
  "success": true,
  "message": "Operação concluída",
  "data": {},
  "requestId": "req_exemplo"
}
```

Em uma falha, verifique o código HTTP e os campos de `error`.

```
{
  "success": false,
  "message": "Não foi possível concluir a operação.",
  "error": {
    "code": "REQUEST_ERROR",
    "statusCode": 400
  },
  "requestId": "req_exemplo"
}
```

Os valores enviados e recebidos pela API pública são em reais. Por exemplo, `5` significa R$ 5,00.

### Campos na resposta

Operações financeiras retornam o ID, valor, taxa, situação e datas. Os campos PIX aparecem quando disponíveis. Uma referência externa permite relacionar o pagamento com um pedido do seu sistema.

## Rate limiting

O limite é de 100 chamadas por minuto por chave. Ao receber HTTP 429, reduza a frequência e aguarde antes de repetir. [Veja os limites de uso.](/docs/api-reference/rate-limiting) Para diagnosticar outras falhas, consulte [erros e códigos HTTP](/docs/api-reference/guides/errors).

## Mapa rápido

[### Rotas da API Encontre todos os endpoints desta versão.](/docs/api-reference/escopo-api-publica)[### Criar cobrança PIX Gere seu primeiro QR Code.](/docs/api-reference/endpoint/payment-pix/create)[### Chave de API Prepare a credencial da integração.](/docs/pages/guides/authentication)[### Webhooks Receba as confirmações automaticamente.](/docs/api-reference/guides/webhooks)
