API Overview

Overview

This document outlines information on the universitywide API Directory.

API Directory

The API Directory offers a robust API publishing and subscription service. This universitywide 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.

Access to the API Directory

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

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.

 

Create and Test

For instructions on how to create and test an API in the API Directory, see Create and Test an API.

Publish

For instructions on how to publish an API in the API Directory, see Publish an API.

Subscribe

For instructions on how to subscribe to an API in the API Directory, see Subscribe to an API.

Generating & Renewing Access Tokens

For more information on how to generate and renew access codes, see Access Tokens.

Grant Access to Application Developers

For instructions on how to grant access to the API Directory for Application Developers, see Grant Access to Application Developers.

Approve Subscription Requests

For instructions on how to grant access to the API Directory for Application Developers, see Approve Subscription Requests.

Add a User to a Provider Organization

For instructions on how to grant access to a Provider Organization, see Add a User to a Provider Organization.

Create a new Developer Organization and Assign an Owner

For instructions on how create a new developer organization and assign an owner, see Create a new Developer Organization and Assign an Owner.

API Directory Field Description

For context around the fields and sections in the API Directory while creating an API in the API Directory, see API Directory Field Description.

Glossary and Frequently Asked Questions

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

 

Last Updated: 
Monday, May 8, 2017