API Requirement Document
API Information
Name | Description |
API Name |
|
API Description |
|
Technical contact (Name and email) |
|
Operational contact (Name and email) |
|
Business contact (Name and email) |
|
Version |
|
API Consumer(s) E.g. Batch job, internal application, other departments, ITS, other UCs or any other university |
|
API Interface Definition
Input Data
Name | Type | Required (yes/no) | Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Output Data
Name | Type | Required (yes/no) | Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Multimedia types |
|
Security Requirement
Authentication |
|
|
|
Authorization |
|
|
|
Operation | Allowed (yes/no) | User Role (If any) | |
READ |
|
| |
WRITE |
|
| |
UPDATE |
|
| |
DELETE |
|
| |
Need for fine grain authorization |
|
|
|
Data classification |
|
|
|
Non-functional Requirement
Describe the quality of services (QoS) that will be delivered by this API
Category | Requirement |
Throughput (Requests per second) - Average |
|
Throughput (Requests per second) – Max allowed |
|
Throughput – Max RPS allowed per user |
|
Max simultaneous users |
|
Uptime requirement |
|
API maintenance window |
|