Controle de receitas e despesas API

Controle de receitas e despesas API, Livro de Receitas e Despesas gerencia os registros no seu próprio aplicativo: listar, adicionar, atualizar e excluir. Os endpoints utilizam uma chave de API em vez de sessão de navegador.

Início rápido

Crie uma chave na seção API para Desenvolvedores da sua conta em https://pixepi.com/pt/conta; a chave em texto simples é exibida apenas no momento da criação.
Envie a requisição para https://api.pixepi.com com o cabeçalho Authorization: Bearer .
As respostas retornam JSON; nos endpoints de lista, você pode usar os campos page, per_page e de filtro.

Exemplo de requisição

curl -H "Authorization: Bearer $PIXEPI_KEY" "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories"

curl -X POST "https://api.pixepi.com/api/v1/apps/gelir-gider-defteri/categories" \
  -H "Authorization: Bearer $PIXEPI_KEY" \
  -d "kind=expense" \
  -d "name=Aluguel"

Endpoints desta ferramenta

Método	Caminho	O que faz
`GET`	`/categories`	Lista as categorias (categorias do sistema compartilhadas mais as suas).
`POST`	`/categories`	Adiciona uma nova categoria.
`POST`	`/categories/{id}`	Atualiza uma categoria.
`POST`	`/categories/{id}/archive`	Arquiva uma categoria; chamar de novo não altera o status.
`GET`	`/entries`	Lista lançamentos; filtra por data, tipo, categoria e observação.
`POST`	`/entries`	Adiciona um novo lançamento.
`POST`	`/entries/{id}`	Atualiza um lançamento.
`POST`	`/entries/{id}/delete`	Exclui um lançamento.
`GET`	`/summary`	Repartição do resumo: por mês, categoria ou tipo.
`GET`	`/export.csv`	Exporta os lançamentos em CSV.

Endpoints compartilhados

Método	Caminho	O que faz
`GET`	`/api/v1/apps`	Catálogo da API
`GET`	`/api/v1/apps/gelir-gider-defteri`	Contrato da ferramenta
`GET`	`/api/v1/usage`	Resumo de uso
`GET`	`/api/v1/openapi.json`	Documento OpenAPI 3.1

Limites

O campo limit nas respostas de lista contém informações de uso e limites.
As informações de cota e plano estão vinculadas à sua conta; confira o status atual com GET /api/v1/usage.

Códigos de erro

Código	Significado
`unauthorized`	A chave de API está ausente ou é inválida.
`forbidden`	Esta operação não é permitida com esta chave.
`not_found`	Ferramenta, tarefa ou registro não encontrado (404 também para acesso entre contas).
`invalid_input`	A validação dos dados falhou (campo ausente ou inválido, data incorreta, etc.).
`invalid_request`	A requisição está malformatada.
`too_large`	O arquivo ou o tamanho do corpo excede o limite.
`unsupported_media`	O tipo de arquivo não é aceito.
`not_supported`	Esta ferramenta não pode ser executada neste endpoint (aplicação com estado).
`not_ready`	A tarefa ainda não foi concluída.
`expired`	O arquivo gerado expirou.
`no_output`	Não há resultado disponível para download nesta tarefa.
`invalid_path`	Caminho de saída inválido.
`quota_exceeded`	Limite de cota ou de taxa excedido.
`rate_limited`	Muitas requisições em pouco tempo. Aguarde um instante e tente novamente.
`csrf`	A verificação do formulário falhou (a API externa usa chaves).
`conflict`	A operação entra em conflito com o estado atual.
`unavailable`	A ferramenta está temporariamente indisponível.
`internal_error`	Erro interno inesperado no servidor.

Documentos

Perguntas frequentes

Onde posso obter uma chave de API?

Crie uma chave na seção API para Desenvolvedores da sua conta; a chave é exibida apenas uma vez, no momento da criação.

Como uma requisição é enviada?

Os endpoints operam em https://api.pixepi.com; cada requisição deve incluir o cabeçalho "Authorization: Bearer <key>".

Quais endpoints a API de Livro de Receitas e Despesas disponibiliza?

A tabela acima lista os endpoints declarados; todos operam com registros vinculados à sua conta e retornam 404 em acessos entre contas.

Como interpretar uma resposta de erro?

O corpo do erro inclui os campos {ok:false, error, code, request_id}; os valores de code constam na tabela de códigos de erro.