Open Money

Projeto Open Source de controle financeiro

1 - Como funciona a ferramenta 2 - Cadastro 3 - Primeiro Acesso 4 - Instalando e Configurando 5 - Outras Dúvidas

Documentação

O OpenMoney é uma ferramenta escrita em PHP que utiliza a API do site meus gastos para disponibilizar uma ferramenta de controle de gastos e fluxo de caixa.

Como funciona a ferramenta

O OpenMoney faz todo o trabalho de integração com o site Meus Gastos, a única informação que é necessário o site parceiro enviar para o Open Money são as credenciais do usuário que está conectado (conhecidas como Token). Abaixo, o fluxo em detalhes.

O usuário acessa o site parceiro, que consulta as credencias do mesmo em seu banco de dados (1) e as envia para o Open Money via variáveis de sessão VL_TOKEN, VL_TOKEN_SECRET e, para finalidade de personalização, salva o nome do usuário na variável NM_USUARIO_MONEY (2).

O OpenMoney utilizando as variáveis acesso os dados do usuário no site Meus Gastos através da API (3) que retorna o pedido através de uma interface JSON (4).

O OpenMoney renderiza a página para o usuário voltar a interagir (5). Cada novo pedido, agora direto do usuário no OpenMoney (6) é tratado pela ferramenta (itens 3, 4 e 5).

Cadastrando

Para utilizar o OpenMoney você vai precisar se cadastrar para utilizar a API do site. Para isso utilize o menu cadastro localizado acima. No momento do cadastro você receberá um login único que irá identificar seu site ou blog (ConsumerKey) e uma senha pré-definida, gerada aleatoriamente para garantir a segurança (ConsumerSecret). Salve-as em um lugar seguro, pois será necessário fornece-la para qualquer acesso a API do Meus Gastos.

Em posse da sua API, acrescente-os no arquivo basico.php, conforme apresentado abaixo.

Primeiro Acesso

Quando você acessa os dados de um usuário do site Meus Gastos pela primeira vez é necessário solicitar permissão para acessar os dados. O processo de solicitação de dados é conhecido como Dança e parece muito mais complexo do que de fato é.

Primeiro o usuário acessa o seu site(1), e com ele já identificado você utilizando seu ConsumerKey e ConsumerSecret solicita ao site Meus Gastos uma senha temporária para validar seu usuário (2).

Com o pedido validado você receberá a senha temporária, conhecida como TokenSecret do pedido(3). Com essa senha temporária, você fara o pedido de autorização para os dados do usuário(4).

O Site Meus Gastos irá então redirecionar o navegador do usuário para o site Meus Gastos pedindo a autorização para que seja concedido permissão para que seu site ou blog acesse as informações do fluxo de caixa dele (5).

Nesta etapa, você poderá fornecer as informações para cadastrar remotamente o usuário fornecendo os dados básicos.

Com a permissão do usuário (6) a API envia um comando ao seu site / app / blog com um login encripitado deste usuário (TOKEN) e uma senha (TOKEN_SECRET) (7).

Atenção que este login e senha só funcionam em conjunto com suas credenciais (ConsumerKey e ConsumerSecret).

Instalando o OpenMoney

O OpenMoney vem com praticamente todos os scripts prontos para uso, porém caso deseje fazer alguma atualização é bem fácil. Vamos aos arquivos importantes que você encontrará ao instalar o OpenMoney:

Arquivo tipo Objetivo
favicon.ico ICO Contêm o icone do OpenMoney que será apresentado ao lado do título da página nos navegadores. Altere se quiser que apareça o seu próprio icone.
open_money.css CSS Contêm as folhas de estilo utilizadas no aplicativo. Se o que você quer é alterar a fonte, cores de menu e fontes é aqui que voce deve mexer.
.htaccess Apache Esse arquivo é essencial. Ele que faz todos os roteamentos dos pedidos do site para a página correta. Só mexa neste arquivo se tiver certeza do que está fazendo.
basico.php Script Contêm algumas das funções utilizadas por todas as páginas. Mais importante, também possui as credenciais do seu site ou blog. Matenha ele atualizado.
index.php Script Trata-se apenas de um verificador de login. Se o usuário estiver conectado (e mantiver um SESSION na variável CD_USUARIO_MONEY ele redireciona para webapp.php, caso contrário ele solicita o login.
login.php Html Arquivo que contêm a tela de login na sua ferramenta. Ao clicar em entrar ele redireciona o processamento para o arquivo processa_login.php
processa_login.php Script Contêm toda a lógica para conectar o usuário. Por padrão vem com uma lógica simples, sem conteudo. Você deve alterar esse arquivo.
webapp.php Script Assim como login.php este arquivo trata os parâmetros recebidos do servidor e redirecionado do .htaccess. Além disso, aqui está a base do leiaute de todas as páginas. Caso queira mudar o menu, acrescentar algum logo ou mensagem, altere esse arquivo.
fusioncharts Pasta Pasta contendo os scripts utilizados para gerar gráficos (http://www.fusioncharts.com/goodies/fusioncharts-free/). Não deve ser alterado.
jquery Pasta Pasta contendo a versão 1.7.1 do jquery, com jquery UI 1.8.17 além de um add-on jquery numeric. Não deve ser alterado.
pages Pasta Página contendo cada uma das páginas que são selecionadas no menu. Só altere caso queira alterar algum detalhe que aparece nas páginas.
rest Pasta Página que faz a conexão com a API do site Meus Gastos. Não altere com exceção dos arquivos request_token.php (solicitação de senha temporária) e request_token_ready.php (script que será chamado ao usuário conceder acesso a sua instalação do OpenMoney).

Recapitulando, os arquivos que você precisa alterar:

Outras Dúvidas

Caso tenha outras dúvidas, entre em contato conosco.

Zeetha™ 2010-2012 - New generation apps
www.meusgastos.com.brwww.meuspostos.com.br