...
We need a workflow to allow developers on campus to request access for APIs that require approval before usage. This is a common use case.
Goals
- Store information about user applications - contact information and other general information. Have a record of the approval to use APIs for a specific application.
Assumptions
- The approval of APIs will be done by business users in most cases, such as the Registrar office.
- Other approvals might be done by technical managers at ETS, ARIT, etc.
Out of Scope
Requirements
| Ticket(s) | Title | User Story | Priority | Notes |
|---|
| Requests API access. | As a Developer, I need a way to request access to APIs for my Apps. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - This functionality is provided by the developer portal. After a user creates an application, they can request access to API(s) by selecting the API link initially, or by selecting Edit <API name> to add more APIs.
|
| Notify developers on API approval | As a developer I would like to receive notification on API approval for automatic and for manual approvals.
| | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - Public APIs are approved automatically.
- Other APIs are approved at a later time and the user is not notified by the system.
- Requesting access to APIs that require approval put the application in Pending mode.
|
| Notify developer on the process to get access | The system should notify the developer in an email after they submit a request to APis that require access of the process to follow. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| - The monitoring service send an email that an application has requested access to an API (that isn't auto-approved)
- Add a notification to the developer as well wit a link on how to request access
|
| Submit access approval documentation | As a developer I need to submit required documentation to have my API access approved. | | Status |
|---|
| colour | Green |
|---|
| title | must have |
|---|
|
| |
| System display a link to documentation on how to submit access request form | The system should display a link to documentation on how to submit an access request form. | | Status |
|---|
| colour | Yellow |
|---|
| title | nice to have |
|---|
|
| - In addition to an email, the website should have a link to the steps to follow to submit access request.
|
User Interaction, Design & Architecture
...