For the complete documentation index, see llms.txt. This page is also available as Markdown.

Endpoints disponíveis

Esta é a visão resumida dos endpoints públicos da API para parceiros do Falcon Finanças.

Autenticação

Método
Endpoint
Descrição

POST

/api/v1/auth/login

Autentica o parceiro e retorna os tokens JWT.

Clientes

Método
Endpoint
Descrição

GET

/api/v1/parceiros/clientes

Lista os clientes vinculados, com filtros opcionais por nome e e-mail.

DELETE

/api/v1/parceiros/clientes/{idCliente}

Inativa o vínculo do cliente com o parceiro.

Planos

Método
Endpoint
Descrição

GET

/api/v1/parceiros/clientes/plano/{idCliente}

Consulta o plano atribuído ao cliente.

PUT

/api/v1/parceiros/clientes/plano

Atualiza limites e recursos do plano do cliente.

A referência OpenAPI vinculada ao GitBook apresenta os parâmetros, exemplos, modelos e respostas gerados diretamente pelo contrato publicado.

Realiza o login do usuário e retorna um token JWT.

post
Corpo
emailstring · mín: 1Obrigatório

Nome do usuário

passwordstring · mín: 1Obrigatório

Senha do usuário

Respostas
200

OK

successbooleanOpcional
messagestring · anulávelOpcional
post/api/v1/auth/login

Retorna os clientes desse parceiro.

get
Autorizações
AuthorizationstringObrigatório

Autenticação JWT usando o esquema Bearer. Exemplo: "Authorization: Bearer {token}"

Parâmetros de consulta
nomestringOpcional
emailstringOpcional
Respostas
200

OK

successbooleanOpcional
messagestring · anulávelOpcional
get/api/v1/parceiros/clientes

Retorna o plano do cliente de um parceiro.

get
Autorizações
AuthorizationstringObrigatório

Autenticação JWT usando o esquema Bearer. Exemplo: "Authorization: Bearer {token}"

Parâmetros de rota
idClienteinteger · int32Obrigatório

ID do cliente

Respostas
200

OK

successbooleanOpcional
messagestring · anulávelOpcional
get/api/v1/parceiros/clientes/plano/{idCliente}

Atualiza o plano do cliente de um parceiro.

put
Autorizações
AuthorizationstringObrigatório

Autenticação JWT usando o esquema Bearer. Exemplo: "Authorization: Bearer {token}"

Corpo
idClienteinteger · int32Opcional
qtdLancamentointeger · int32 · anulávelOpcional
qtdAnexointeger · int32 · anulávelOpcional
qtdFornecedorinteger · int32 · anulávelOpcional
qtdUsuariointeger · int32 · anulávelOpcional
qtdEmpresainteger · int32 · anulávelOpcional
agendastring · anulávelOpcional
recibostring · anulávelOpcional
importacaostring · anulávelOpcional
fluxoCaixastring · anulávelOpcional
cartaoCreditostring · anulávelOpcional
controleAcessostring · anulávelOpcional
orcamentostring · anulávelOpcional
integracaostring · anulávelOpcional
boletostring · anulávelOpcional
dataValidadestring · date · anulávelOpcional
Respostas
200

OK

successbooleanOpcional
messagestring · anulávelOpcional
put/api/v1/parceiros/clientes/plano

Inativa o vinculo de um cliente de um parceiro.

delete
Autorizações
AuthorizationstringObrigatório

Autenticação JWT usando o esquema Bearer. Exemplo: "Authorization: Bearer {token}"

Parâmetros de rota
idClienteinteger · int32Obrigatório
Respostas
200

OK

successbooleanOpcional
messagestring · anulávelOpcional
delete/api/v1/parceiros/clientes/{idCliente}

Atualizado