API Overview

Overview

This document outlines information on the university-wide API Directory.

API Directory

The API Directory offers a robust API publishing and subscription service. This university wide directory allows secure and authorized access to institutional data for use in research and innovative applications. University departments are able to authorize and manage access to their data sets using the API directory. Data owners have tools to audit use, grant or deny access requests, and use automated roll on and off processes.

Availability

The API Directory should have little or no down time during software patches and releases. APIs are hosted on the API Directory infrastructure, but still rely on the back-end system to provide data for the APIs. Data from individual APIs are available when the host system is.

API Directory Data Domains

The API Directory has presence among various Data domains within the University. For an overview of the enterprise subject areas, and which areas have published APIs, see API Directory Data Domains.

Access to the API Directory

For access to the API Directory, see Getting Started page for instructions and links to applicable forms.

Manage Teams

For instructions on how to manage teams, see Managing Teams.

Manage Apps

For instructions on how to manage apps, see Managing Apps.

Consume an API

For instructions on how to consume an API, see Consuming an API.

What is OAuth?

See the following video to walk through how institutional data is securely delivered using OAuth and review the steps that 3-legged OAuth uses to release personal information to Apps.

 

API Development

For instructions on how to develop and publish APIs, see Developing and Publishing APIs.

For resources specific to Apigee X, see Apigee X Developer Resources.

Approve API Subscription Requests

For instructions on how to approve API subscription requests, see Approving API Subscription Requests.

Grant Access to Apigee

For instructions on how to grant access to Apigee for application developers, see Granting API Developer Access to Apigee.

Glossary and Frequently Asked Questions

For an alphabetical list, and definitions, of terms related to APIs, see API Glossary.

For a list of frequently asked questions, see API FAQ.

 

Last Updated: 
Wednesday, February 15, 2023