30 lines
1.6 KiB
Markdown
30 lines
1.6 KiB
Markdown
|
# SMOA iOS app (scaffold)
|
||
|
|
|
||
|
|
This folder is a **scaffold** for the SMOA iOS app. The actual app is to be implemented in a separate Xcode project or repo, targeting **iOS 15, 16, and 17** (last three generations).
|
||
|
|
|
||
|
|
## Contract
|
||
|
|
|
||
|
|
- Use the same **REST API** as Android and Web: see [PLATFORM-REQUIREMENTS.md](../reference/PLATFORM-REQUIREMENTS.md) and [REQUIREMENTS-ALIGNMENT.md](../reference/REQUIREMENTS-ALIGNMENT.md).
|
||
|
|
- **Sync:** POST to `/api/v1/sync/directory`, `/api/v1/sync/order`, etc.; DELETE for sync delete.
|
||
|
|
- **Pull:** GET `/api/v1/directory`, `/api/v1/orders`, `/api/v1/evidence`, `/api/v1/credentials`, `/api/v1/reports` (with `since`, `limit`, optional filters).
|
||
|
|
- **Auth:** Header `X-API-Key` or query `api_key`.
|
||
|
|
- **Response:** JSON; when `conflict: true`, `remoteData` is base64-encoded JSON.
|
||
|
|
|
||
|
|
## Implementation checklist
|
||
|
|
|
||
|
|
- [ ] Create Xcode project (Swift/SwiftUI or cross-platform); minimum deployment target iOS 15.0.
|
||
|
|
- [ ] Store API key in **Keychain**.
|
||
|
|
- [ ] Implement **PullAPI** (URLSession or Alamofire): GET endpoints above.
|
||
|
|
- [ ] Implement **SyncAPI**: POST sync + DELETE; parse `SyncResponse`, decode `remoteData` when conflict.
|
||
|
|
- [ ] **Offline queue:** Queue sync when offline; retry when online; optional Core Data / SwiftData for persistence.
|
||
|
|
- [ ] Optional: Face ID / Touch ID for app unlock; certificate pinning for API.
|
||
|
|
|
||
|
|
## Discovery
|
||
|
|
|
||
|
|
- GET `/api/v1/info` returns `endpoints` (sync, delete, pull) and `auth` for client discovery.
|
||
|
|
|
||
|
|
## References
|
||
|
|
|
||
|
|
- Backend: [backend/README.md](../../backend/README.md)
|
||
|
|
- Platform requirements: [docs/reference/PLATFORM-REQUIREMENTS.md](../reference/PLATFORM-REQUIREMENTS.md)
|