Scott.Idem/OSIT-AE-API-FastAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Saving updates to notes. Less reference to the _random.

Browse Source
This commit is contained in:
Scott Idem
2026-02-19 16:20:25 -05:00
parent 17a627a981
commit 1db71f85a5
1 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/GUIDE__V3_FRONTEND_API.md
View File

@@ -1,6 +1,6 @@
# Aether API V3 Frontend Integration Guide (Svelte/TypeScript) # Aether API V3 Frontend Integration Guide (Svelte/TypeScript)
This guide defines the standards for interacting with the **Aether API V3 CRUD** and **Action** endpoints. This guide defines the standards for interacting with the **Aether API V3 CRUD** and **Action** endpoints.
--- ---
@@ -16,7 +16,7 @@ V3 architecture enforces strict **Multi-Tenant Isolation** and **Machine Authori
### B. The "Visa" (Account Context) ### B. The "Visa" (Account Context)
Required for any non-public data (Journals, Badges, Users, etc.). Required for any non-public data (Journals, Badges, Users, etc.).
1. **Standard Access**: Provide the `x-account-id` (the random string ID). 1. **Standard Access**: Provide the `x-account-id` (the random string ID).
* **Header:** `x-account-id: <account_id_random>` * **Header:** `x-account-id: <account_id>`
2. **Administrative Bypass**: For authorized scripts needing global access. 2. **Administrative Bypass**: For authorized scripts needing global access.
* **Header:** `x-no-account-id: bypass` * **Header:** `x-no-account-id: bypass`
3. **Token Access**: Provide a **JWT** in the query string. 3. **Token Access**: Provide a **JWT** in the query string.
@@ -41,8 +41,8 @@ When the frontend first loads and doesn't know the `account_id`, it performs a "
} }
``` ```
**Results:** **Results:**
* Returns 200 + a list containing the `account_id` and `site_id` random strings. * Returns 200 + a list containing the `account_id` (random string ID) and `site_id` (random string ID).
* ** ڈیزائن Choice:** If the domain is not found, it returns **200 OK with an empty list `[]`**. It is NOT a 404. * ** デザイン Choice:** If the domain is not found, it returns **200 OK with an empty list `[]`**. It is NOT a 404.
--- ---
@@ -50,7 +50,7 @@ When the frontend first loads and doesn't know the `account_id`, it performs a "
### A. GET by ID ### A. GET by ID
Used when the ID is known. Used when the ID is known.
* **Endpoint:** `GET /v3/crud/{obj_type}/{id_random}` * **Endpoint:** `GET /v3/crud/{obj_type}/{id}`
* **Security:** Returns 403 if the record doesn't belong to your `x-account-id`. * **Security:** Returns 403 if the record doesn't belong to your `x-account-id`.
### B. POST Search ### B. POST Search
@@ -62,11 +62,11 @@ The primary way to retrieve data.
## 4. Event File Data Retrieval (Hosted Files) ## 4. Event File Data Retrieval (Hosted Files)
Event Files (`event_file`) often have associated Hosted Files (`hosted_file`) which contain binary data and metadata like SHA256 hashes, content types, and sizes. To retrieve this additional data: Every Event File (`event_file`) **must** have a linked Hosted File (`hosted_file`). The Hosted File itself is a metadata record for binary content (files), which is accessed via separate Action endpoints (e.g., `/v3/action/hosted_file/download`). This API endpoint provides metadata about the associated hosted file. To retrieve this additional metadata:
* **Endpoint:** `GET /v3/crud/event_file/{event_file_id_random}` * **Endpoint:** `GET /v3/crud/event_file/{event_file_id}`
* **Query Parameter:** Add `inc_hosted_file=true` * **Query Parameter:** Add `inc_hosted_file=true`
* Example: `/v3/crud/event_file/<event_file_id_random>?inc_hosted_file=true` * Example: `/v3/crud/event_file/<event_file_id>?inc_hosted_file=true`
**Response Impact:** **Response Impact:**
@@ -86,4 +86,3 @@ If you receive a 403 on a valid ID:
2. Ensure you are sending `x-account-id` and NOT `x-aether-api-token`. 2. Ensure you are sending `x-account-id` and NOT `x-aether-api-token`.
3. Verify the record actually belongs to the account ID you are sending. 3. Verify the record actually belongs to the account ID you are sending.
4. Check if the object is marked `public_read: True` in the registry. (Posts and Archive Content allow guest access; Journals and Badges do not). 4. Check if the object is marked `public_read: True` in the registry. (Posts and Archive Content allow guest access; Journals and Badges do not).