Sign in Join

Live chat for Free Pascal, Lazarus, Delphi and every Pascal programmer.

Catalog · How the catalog works

Random project

CaixaVirtual

Api Caixa Virtual

View on GitHub

Anyone may press Interesting, signed in or not. It helps others find this project.

Member rating

No ratings yet.

Sign in to rate this project.

README

CaixaVirtual

Api Caixa Virtual

A Documentação completa da Api pode ser encontrada neste link [https://documenter.getpostman.com/view/636961/TVCiUn1w](https://documenter.getpostman.com/view/636961/TVCiUn1w)

Pré-requisitos - Build

  • Basta baixar e compilar a aplicação utiliando o Delphi Tokyo
  • Há uma pasta Modules no diretório Raiz do projeto, esta pasta e suas subPastas precisam estar no search path do projeto para ele compilar
Obs.: Verificar o search path do atual do projeto e apontar para o diretório onde esta o projeto.

Pré-requisitos - Execução

  • Firebird 3.0 Instaldo e em execução
  • Junto ao .exe do servidor há um aquivo .ini nele é necessário configurar
    • O Caminho do banco de dados
    • o IP do servidor ondo esta o banco de dados
    • A porta onde o Firebird esta rodando
      pascal
      [BANCO]
DATABASE=C:\Users\Documents\CaixaVirtual\DataBase\DBCAIXAVIRTUAL.FDB
SERVER=127.0.0.1
PORT=3050
  • A Aplicação é Console basta que ele estaja aberta para que respondas as requisiçãoes
    • A Porta padrão da aplicação é 9000
ps.: não foi criado recurso para alterar a porta da aplicação.
ps2.: por questão de comodidade o usuário e senha padrão do firebird foram mantidos: Usuário: SYSDBA - Senha: masterkey

Rota padrão para acessar a aplicação

pascal
    http://localhost:9000/[recurso]

Recursos Diponíveis na API

  • /login
pascal
    Get

Autenticação requirida.

basic-auth - Usuário e Senha para Teste
userName: caixa - password: API

A Api irá retornar um token que deverá ser utilizado para em todos os outros recursos.

  • /usuario
pascal
    Get
        Listar todos - /usuario
        Listar um - /usuario/:id_usuario
pascal
    Post
        /usuario
pascal
    put
        /usuario/{id_usuario}
pascal
    delete
        /usuario/{id_usuario}
  • /categoria
pascal
    Get
        Listar todas - /categoria
        Listar uma - /categoria/:id_categoria
pascal
    Post
        /categoria
pascal
    put
        /categoria/{id_categoria}
pascal
    delete
        /categoria/{id_categoria}
  • /movimentacoes
pascal
    Get
        Mostrar o Saldo - /movimentacoes/Saldo
        Mostra uma movimenta????o - /movimentacoes/{:id_movimentacao}
pascal
    Post
        /movimentacao
pascal
    put
        /movimentacao/{id_movimentacao}
pascal
    delete
        /movimentacao/{id_movimentacao}
pascal
    That's a change for teste