suap-wrapper

Wrapper escrito em JavaScript para acessar a API do Sistema Unificado de Administração Pública (SUAP).

Usando

O suap-wrapper está disponibilizado através do npm (gerenciado de pacotes para Node.js), então:

npm install --save suap-wrapper

Após isso, você já pode usar o suap-wrapper no seu projeto:

'use strict';
 
const Suap = require('suap-wrapper');
 
Suap.autenticar('2016012345789', 'minh4senh4', (err, data) => {
  if (err) {
    console.log(err.message);
    return;
  }
 
  console.log(`Seu token é: <${data.token}>.`);
});

Ajudar no desenvolvimento

Estas instruções orientarão você sobre como ajudar no desenvolvimento do projeto.

Requisitos

Você precisar ter o Node.js instalado em sua máquina. Após instalar, verifique se node e npm estão no seu path:

node --version
npm --version

Instalando

Fork e clone o repositório, depois peça para o npm instalar as dependências:

git clone https://github.com/seu-usuario/suap-wrapper.git
cd suap-wrapper
npm install

Após estes comandos, você deve ter na sua pasta:

├── index.js
├── LICENSE
├── node_modules
│   └── axios
├── package.json
└── README.md

Agora é só olhar a documentação da API do SUAP e adicionar novas funcionalidades.

Feito com...

• Axios

Contribuição

Ficaremos muito felizes se você contribuir com este projeto seja enviando Pull Request ou notificando bugs pelas Issues.

Versionamento

Estamos usando o SemVer para versionamento. Para ver as versões disponíveis: tags deste repositório.

Autores

• Felipe Pontes - Trabalho inicial - felipemfp

Veja também a lista de contribuidores que participaram deste projeto.

Licença

Este projeto é licenciado pela Licença MIT - veja o arquivo LICENSE para mais detalhes.