Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Document Title
[Department Name]








Revision 1.0
18 July 2016


Table of Contents
API Information
API Interface Definition
Input Data
Output Data
Security Requirement
Non-Functional Requirement
Revision History
Sign-off Tracking Chart













API Information


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

 


API Interface Definition

Input Data

Name

Type

Required (yes/no)

Description

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


Output Data

Name

Type

Required (yes/no)

Description

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


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

 


Security Requirement

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

 

 

 

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

 

 

Revision History

The following revisions have been made to this document.

Version

Version Date

Revision Summary

Author

1.0

01/01/2010

First draft

Joe Smith


Sign-off Tracking Chart

This document has been reviewed and approved by the following signatories.

Approved By

Role/Area of Responsibility

Version

Date Approved

Approval Method

Jane Doe

Sponsor, VC BA

1.2

01/10/2010

Approved Doc

 

 

 

 

 


  • No labels