fatec-api
API for SIGA from Centro Paula Souza made for students to create scripts based in their profile data.
Usage
Install the package:
npm install fatec-api --save
Check the documentation at: https://filipemeneses.gitbooks.io/fatec-api/
Getting Started
A quick example will show how to use it, scrapping the user name. And will cover the usage with Node.js using ES6 syntax.
const fatecApi = const myAccount = 'LOGIN' 'PASSWORD' myAccount
How it works
This library scrap data using HTTP requests with request
and parses the HTML with cheerio
library.
The auth/Account
class does the heavy lifting, making the requests using core/Network
. The scrapped data is later available at the attribute student
of the auth/Account
instance.
Here's the flow of account.getName()
:
Check out the documentation for more info.
Documentation
Available at: https://filipemeneses.gitbooks.io/fatec-api/
Discussion
Available at: https://discord.gg/RUv5Kxw
Development
- Clone:
git clone https://github.com/filipemeneses/fatec-api.gitcd fatec-api
- Install:
npm i
- Test:
Create the .env
file in the root with the required values to test.
LOGIN=TEST
PASSWORD=TEST
NAME=TEST
There is two important test files to keep track with:
tests/FatecApi.test.ts
to test the library features
npm run test:api
tests/Siga.test.ts
to test the integrity of SIGA (check if scrapped tags remains the same)
npm run test:siga
To test all:
npm run test