Objective

To provide a campus wide API solution to securely provide data through standardize interfaces for all campus members and associated entities. To create a centralized access point where API providers can list data services they provide and find data services they larger community can consume. To ensure data security through clearly documented, standardized, accessible and actionable policies and best practices. To cultivate a forum where data can be used to service and extend the many aspects of research, development, and business needs of the campus.

API Roadmap

API	Description	Status	Start	Estimated Completion
Power BI Active Directory Management API	Insert users in Power BI AD groups to assign Power BI access.	IN PROGRESS	04 May 2020
Curriculum Space Available	Provide the space available for each section. This will prevent people from calling the curriculum API just to get the space available.	PROPOSED
Curriculum Finals	Include course finals information in the curriculum API. Requested by the GoGaucho team.	PROPOSED
Curriculum Prerequisites	Include course prerequisites in the curriculum API. Requested by a student.	PROPOSED
Curriculum instructor employee numbers	Nectir has requested an API that returns the instructor employee numbers for each class. The current curriculums API returns the instructor name, but not the id. For this reason Gaucho Space cannot use the curriculums API either.	PROPOSED
Employee	Employee name and appointment type information	PROPOSED
TA Verification	API to verify how many quarters a person has been a TA. Requested by Academic Senate IT	PROPOSED
Parking Structure Free Spaces Information	Retrieve the number of free spaces in a parking structure	PROPOSED
Identity Provisioning/Deprovisioning Records	Retrieve list of identities which have had a lifecycle event status change. Provisioning Events: Record creation, addition of an affiliation. Deprovisioning Events: Record "soft" deletion, removal of an affiliation.	PROPOSED
Housing Properties	List of places where students, faculty, staff can live	PROPOSED
Campus Buildings	All the campus buildings. Source has been identified as https://ucsb.metabim.com/	PROPOSED
Housing Current List of Residents	Do they live here? And, where do they live? There is a need to feed student residence into the SIS Gaucho Blue. There is also need to verify student residency one student at a time for some of the Housing needs.	PROPOSED
Employee Photos	Return the Access Card photos for employees by the UCPath employee ID. It will include the photo hash as well. On hold due to HR concerns.	ON HOLD	01 Mar 2019	29 Mar 2019

Roadmap

Project	Summary	Status	Start	Estimated Completion
Drupal 8	Upgrade the Drupal Portal to version 8. This will use the Drupal 8 Apigee plugin (which is still in prerelease).	IN PROGRESS	06 May 2019	30 Aug 2019
Usage Reports	Develop API usage reports and make them available to stakeholders and developers who do not have access to the Gateway.	IN PROGRESS	01 Apr 2019	17 Jan 2020
Apigee Teams Feature	Apigee's "Companies" (ie. Teams) feature is a plugin for the Drupal portal with tie-ins to the API Gateway backend. It will allow developers to create Teams, and associate the applications they create with their Teams, rather than themselves.	RESEARCHING
Account Cleanup Project	On an annual basis we would like to review the accounts we have in the system in order to remove accounts that should no longer be active and reduce our security risk profile. To do this we will want to check what accounts are not in active use or their owners are no longer affiliated with the University.	RESEARCHING
Campus API Security Improvements	Better integrate the API security model with the Campus IdM Team's security model. Look at creating service accounts at the campus level and managing their access through the gateway within https://developer.ucsb.edu. Secondary Ask: Campus Identity Resource Request	RESEARCHING
Automated Tasks - Access Request Monitor	An automated task which will monitor access requests from users to auto-approve particular APIs and send Access Request information about restricted APIs.	RESEARCHING
@apibot - Reporting	Generate reports on API Usage, Access Violations, and Errors.	RESEARCHING
Statuspage.io Integration	Have a Statuspage to show the availability and history of the APIs and overall system. Similar to SA's statuspage.	WISH LIST
Client Library Reference Architecture	Build a client library that demonstrates how to use the API Key and UCSB Net ID/password combination to retrieve data. This project should be hosted in Github and if possible, a build should be hosted on a public repository (nuget).	WISH LIST
Drupal - Account Creation Review (Approve/Deny)	An extension to drupal which will look at an new account creation. Given a simple set of rules some account requests should be able to be auto-denied. Maybe some can also be auto approved.	RESEARCHING

Completed

Project	Summary	Status	Start	Completion
Student Email Address BARC	Return students with changes to the email address in the last x number of days.	COMPLETED	19 Jun 2020	24 Jul 2020
Academic Quarter Calendar BARC	Retrieve quarter-calendar records in a format specific to BARC.	COMPLETED	01 Jun 2020	24 Jul 2020
Graduate Division Applicant Verification (Private)	Verify graduate student admissions application information. Will be used in housing process for new grad students.	COMPLETED	01 Jul 2019	01 Nov 2019
Library Employee List (Private)	Employee name and appointment type information to be used in the Library Alma system to validate current employment status.	COMPLETED	17 Jun 2019	30 Aug 2019
Academic Curriculum (Registrar)	Curriculums service for Campus API (Box)	COMPLETED	10 Jun 2019	25 Jul 2019
Recreation Patron Photos (Private)	Return the student or employee Access card photos by perm or UCPath employee ID (the Fusion padded ID).	COMPLETED	15 Feb 2019	29 Mar 2019
Housing Contract Admissions Status	What status the students housing contract is in	COMPLETED	01 Jan 2019	15 Mar 2019
@apibot - Javascript Conversion	Take the existing functionality of @apibot and convert it from Powershell to Javascript. Move hosting of the bot on the Google Cloud Platform. Develop a workflow that multiple people can develop scripts for it at the same time. Create a CI/CD deployment chain to ensure successful updates.	COMPLETED	01 Jun 2018	01 Apr 2019
Students Rosters (Registrar)	Rosters service for Campus API (Box)	COMPLETED	01 Jun 2019	30 Apr 2019
Meal Plan Information	Meal plans and rates	COMPLETED	28 Jan 2019	28 Feb 2019
Workflow - Access Request	Create a new workflow to improve requesting access to an API. The workflow should capture information about the application and the approveral which can be referenced later on for auditing purposes.	COMPLETED	01 Oct 2018	01 Feb 2019
Workflow - Publish a New API	Install a workflow system into the Drupal portal and developer a "Publish a New API (for Data/API Providers)" workflow.	COMPLETED	01 Apr 2018	01 Feb 2019
API - Registrar Courses & Student Schedule Public Service	Courses service for Campus API (Box)	COMPLETED	08 Oct 2018	01 Feb 2019
API - Registrar Students Public Service	Students service for Campus API (Box)	COMPLETED	23 Jul 2018	14 Dec 2018
API - Dining Commons General Information	Names, Locations, etc.	COMPLETED	01 Nov 2018	14 Dec 2018
Status Monitoring and Healthchecks	Use a monitoring system to make sure we are notified when an API is unavailable.	COMPLETED	27 Oct 2018	30 Nov 2018
Slack Integration - @apibot	Create a slack integrtion hubot which will handle: search for newly created developer accounts, api product approval, and target server gateway configuration	COMPLETED	01 Nov 2017	31 May 2017
Initial Rollout	Create First APIs, Developer Portal, Introductory Documentation, and Communicate with Campus the availability of the System	COMPLETED	01 Nov 2017	24 Apr 2018

Principles

(We don't always achieve these, but this is what we're shooting for)

Easy to Find APIs

Provide an easy and quick to use Developer Portal for finding APIs and the data they provide. In order for APIs to be useful, people need to use them and the first step to do that is make them easily found through search engines and clear documentation.

Efficient and Secure Access Management to APIs

Ensure data security through multiple layers of data security mechanisms while still providing efficient processes for granting access and using services. Data security mechanisms include secure communication, client & user authentication, data protection filtering, and authorization.

Standardized and Consistent Data Interfaces

Create a consistent understanding of data and it's usage through standardized interfaces, naming conventions, documentation, and functionality. Ensure consistent usage of data by providing API services with common and reusable logic that can be maintained by campus subject matter authorities and can be used by all campus members.

Governed and Managed API Change Processes

Enable API change management to occur through structured and well known channels that ensure data stability and consistency. Preserve community access to improvements and changes through an open and accessible governance process.

Browser not supported