Draft: New Browser Extension (BE) Exclusive API Endpoint (v1) - 2023-04-30

Target release	Type // to add a target release date
Epic	API-14 - Browser Extension API Endpoint ToS;DR Received
Document status	DRAFT
Document owner	@a user
Designer	@a user
Tech lead	@a user
Technical writers	@a user @a user
QA	@a user @a user

🎯 Objective

New Extension Endpoint exclusively for the Browser Extension. This endpoint downloads the whole Database (services, approved points) and provides it to the client for offline caching.

📊 Success metrics

Goal	Metric
N/A

🤔 Assumptions

Secure Endpoint for use with BE only. Session Validation via Appwrite?

🗒 Requirements

Requirement	User Story	Importance	Jira Issue	Notes
Endpoint Security	Prevent HTTP Clients, Crawlers or Third Parties without a valid session from accessing the endpoint.	HIGH	API-14 - Browser Extension API Endpoint ToS;DR Received	Save Bandwidth and secure reliability
Compression	Compress as tar.gz or use raw json?	HIGH	API-14 - Browser Extension API Endpoint ToS;DR Received
Cache	The Database should be cached for 1 week and stored on the filesystem to prevent database pileup.	HIGH

🎨 Request Structure

https://api.tosdr.org/extension/v1/

CODE

🎨 Response Model

Open Questions

Question	Answer	Date Answered