Name

Description

API Name

API Description
Add api description here…

Technical contact (Name and email)
Who should users contact if they have technical questions

Operational contact (Name and email)
Who should user contact if the API if user encounters operational issue

Business contact (Name and email)
Who is responsible for approving API subscription requests?

Version

API Consumer(s)
Who is expected to consume this API and how many users are expected to use this API?

E.g. Batch job, internal application, other departments, ITS, other UCs or any other university

Name

Type

Required (yes/no)

Description

Multimedia types
Supported media type - JSON, xml, pdf, csv

Authentication
Describe access control requirement for this API

Authorization

Operation

Allowed (yes/no)

User Role (If any)

READ

WRITE

UPDATE

DELETE

Need for fine grain authorization
For read operation, is there a need to make subset of information available based on a user attributes? If yes, please describe.

Data classification
Public, Confidential or Sensitive

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

Version

Version Date

Revision Summary

Author

1.0

01/01/2010

First draft

Joe Smith

Approved By

Role/Area of Responsibility

Version

Date Approved

Approval Method

Jane Doe

Sponsor, VC BA

1.2

01/10/2010

Approved Doc