Opportunity APIs¶
Why This Exists¶
This document defines API responsibilities for the Opportunity Domain.
It does not define implementation code or final OpenAPI specifications.
Owner¶
The owner is the Chief Product Officer and Enterprise Architect.
Business Value¶
Opportunity APIs expose governed tender discovery, indexing, matching, watchlist, saved opportunity, qualification, and recommendation behavior.
API Groups¶
| API group | Responsibilities | Example endpoints |
|---|---|---|
| Tender Source API | Manage tender sources. | POST /opportunity/sources, GET /opportunity/sources |
| Tender Opportunity API | Create, retrieve, update tender records. | POST /opportunities, GET /opportunities/{tenderOpportunityId} |
| Tender Document API | Manage tender document metadata and indexing state. | POST /opportunities/{id}/documents |
| Tender Requirement API | Capture and read tender requirements. | GET /opportunities/{id}/requirements |
| Briefing Session API | Track briefing sessions. | POST /opportunities/{id}/briefings |
| Deadline API | Track deadlines. | POST /opportunities/{id}/deadlines |
| Matching API | Request or read Organization matches. | POST /opportunities/{id}/matches, GET /organizations/{organizationId}/opportunity-matches |
| Qualification API | Manage qualification assessments. | POST /opportunities/{id}/qualification |
| Recommendation API | Read and update recommendation records. | GET /opportunities/{id}/recommendation |
| Watchlist API | Manage watchlists. | POST /organizations/{organizationId}/watchlists |
| Saved Opportunity API | Save and manage tender pipeline records. | POST /organizations/{organizationId}/saved-opportunities |
API Principles¶
- APIs must preserve source metadata.
- APIs must not mutate Organization or Compliance state.
- APIs may consume Intelligence analysis but Opportunity owns recommendation records.
- APIs must not create proposal content.