cisagov / cisagov/XFD

Configure Backend Functionality to Parse Organization with Assets API Data

Open
#135 0 comments 0 reactions 1 assignee Claimed by @DJensen94 View on GitHub
backend improvement
Dominant language
Python
Stars
30
Forks
22
Avg merge
1d 21h
Merged PRs (30d)
22

Description

# 💡 Summary #

Create and Integrate Organizations with Assets endpoint to retrieve stakeholder data. To achieve this, we need to set up the backend functionality that can efficiently fetch data from the API endpoints and parse the data appropriately.

## Implementation notes ##

- Create the relevant API endpoints in the DMZ
- Implement the necessary HTTP requests (GET, POST, etc.) to interact with the API.
- Handle authentication (if required) to access the API securely.
- Design data models or schemas to represent the fetched data.
- Parse the API responses and extract relevant information.
- Store the data in our backend database
- Set up a scheduler (e.g., cron job) to periodically pull data from the API.
- Determine an appropriate frequency for data updates (e.g., hourly, daily).
- Implement error handling mechanisms for API requests (e.g., retries, timeouts).
- Log relevant information (e.g., timestamps, response codes) for debugging and monitoring.

## Acceptance criteria ##

- [ ] The backend functionality successfully retrieves data from the Universal API.
- [ ] Data is correctly parsed, stored, and accessible within our application.
- [ ] Scheduled data retrieval runs without issues.
- [ ] Error handling and logging are in place.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.