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

« Previous Version 5 Next »

Objective

To describe all areas required to support the API Management platform Apigee at UCSB, and the responsible people for each area. The platform consists of two main tools - the developer portal, and the gateway, both described below. 

Developer Portal (https://developer.ucsb.edu/): used for API discovery and access/publishing requests. API users sign up for the developer portal, create an App, and request access to APIs for their app. An API key is given to them to be able to access the APIs. The API team has developed access request forms to manage the API publishing and API access requests and record the decisions. The API team has developed standards and guidelines for API use by employees, and by students. 

Gateway (https://login.apigee.com/login): used for API publishing, execution, and statistics. Gateway accounts require Apigee license. Users publish APIs, grant API access to Apps, have access to Apigee reports in the gateway to troubleshoot errors and to view API usage statistics. 

Apigee Responsibility Matrix

AreaDutiesPrimary Responsible PersonOther Responsible PeopleDocumentation Links

Developer Portal Account Approval

  • Verify a valid ucsb affiliation.
  • Verify student or employee affiliation.
  • Approve/deny account.
  • Add to google groups.
Diana AntovaSteven MaglioAPI team has access to approve/deny accounts

https://developer.ucsb.edu/docs/approving-accounts

https://developer.ucsb.edu/docs/accounts/developer-portal

Governance - API Access Requests

  • Review API access requests
  • Request access approval form submission.
  • Review provided information on access request form is sufficient.
  • Route requests through the workflow.
  • Meet with the developer to understand the need and the best way to serve their need.
  • Approve API access request form.
Diana AntovaSteven Magliohttps://developer.ucsb.edu/docs/applications/application-approval-request
Governance - API Publishing Requests
  • Review API publishing requests.
  • Route request through the workflow.
  • Review that API meets the development standards.
  • Publish the API in the gateway.
  • Create API documentation in developer portal to make it available for access requests.
Steven MaglioKevin WuGary Scott https://developer.ucsb.edu/api-publishing-request
Governance - Gateway admin 
  • Review technical information on API access requests, including security information.
  • Approve API access request in gateway. 
Steven Maglio

Diana AntovaKevin Wuchristian.montecino (Unlicensed)

https://developer.ucsb.edu/docs/gateway-admin/processing-api-access-request
Application Development Support
  • Provide guidance on LDAP account creation
  • API use guidelines for developers
  • Security guidelines
Steven MaglioKevin WuGary Scott

https://developer.ucsb.edu/docs/accounts/ldap-accounts

https://developer.ucsb.edu/getting-started

https://developer.ucsb.edu/creating-your-first-app

https://developer.ucsb.edu/trying-out-apis

https://developer.ucsb.edu/docs/applications/testing-applications

https://developer.ucsb.edu/docs/security/overview

https://developer.ucsb.edu/docs/security/application-security-review

Student Development Support

  • Provide guidelines to students on application development.
  • Review security implementation for apps using APIs that require approval.
  • Perform periodic code review for apps using APIs that require approval.
Steven MaglioSeth NorthropDiana Antovahttps://developer.ucsb.edu/docs/applications/student-developed-applications
Business API Access Approval
  • Review API access requests
  • Approve/deny API access requests
  • Review API Publishing Requests
  • Approve/deny API publishing requests
Diana AntovaSteven Maglio

https://developer.ucsb.edu/business-api-access-request-approver

Each API Publishing Request form contains the name(s) of people that are allowed to approve the publishing of an API and access requests. Depending of the data, these will be different people. 

New API Development
  • Receive requests from customers for new APIs.
  • Determine system of source.
  • Work with system developers to request the APIs.
  • Provide guidance on API development.
Steven MaglioDiana Antova
Developer Portal Development
  • Use the Drupal platform to maintain the developer portal.
  • Add/edit pages.
  • Create workflows and rules
  • Setup automatic emails
Ian Lessing (Unlicensed)Diana AntovaSteven MaglioVince Nievares
Developer Portal Maintenance
  • Apply Drupal patches
  • Apply Apigee patches
Ian Lessing (Unlicensed)Steven MaglioVince Nievares
Slack commands support
  • Create new slack commands for gateway operations  automation
Kevin WuSteven Maglio
  • No labels