38 lines
821 B
Markdown
38 lines
821 B
Markdown
|
# To Do
|
||
|
|
|
||
|
|
- [ ] Need to create an agent to send data
|
||
|
|
- [ ] Need to create api endpoint to handle request
|
||
|
|
- [ ] Need a new table for accounts
|
||
|
|
- Users can belong to accounts
|
||
|
|
|
||
|
|
## How will authentication work?
|
||
|
|
JWT or Oauth based tokens
|
||
|
|
|
||
|
|
## Lightweight agent
|
||
|
|
What data will the agent need to send:
|
||
|
|
1. Gather user data
|
||
|
|
2. Account id
|
||
|
|
3. Site id
|
||
|
|
|
||
|
|
The agent should be availableas a simple script.
|
||
|
|
|
||
|
|
## API Endpoints
|
||
|
|
|
||
|
|
```
|
||
|
|
/api/webhook
|
||
|
|
```
|
||
|
|
This will receive a JSON payload from the agent
|
||
|
|
It will parse the payload to store the data for later display
|
||
|
|
|
||
|
|
```
|
||
|
|
/api/dataset/{account_id}/{site_id}
|
||
|
|
```
|
||
|
|
This will provide all metrics to allow displaying
|
||
|
|
information about the account.:w
|
||
|
|
|
||
|
|
```
|
||
|
|
/api/site-list/{account_id}
|
||
|
|
```
|
||
|
|
This will provide a list of sites for a given account.
|
||
|
|
Each account can have unlimited sites. Each site has an id.
|