Princeton's WSO2 API Platform


In this Article:

This article provides information on how to work with OIT to utilize the API (Data Integration) service  offered by the Software Infrastructure Services (SIS) group that resides in Software and Application Services group, in the Office of Information Technology.

Contents

1       Overview of Princeton’s API Platform... 1

2       How to request the creation of an API.. 1

3       How to subscribe to an API.. 1

4       How to request access to the SDK and build your own APIs.. 1

5       How to report a bug in an API.. 1

6       Contact Information. 1

 

1       Overview of Princeton’s API Platform

OIT has deployed an API platform to serve as the centralized host for managed APIs in the OIT technology environment.  This platform consists of the following components:

    1. API Manager
      1. API Gateway – acts as the front door for managed APIs, conducting authentication, authorization, I/O metering, monitoring and analytics.
      2. API Publisher – captures API configuration parameters for visibility, access, I/O capacity, authorization grant types and OAuth token duration.
      3. API Store – groups APIs under application subscriptions and associates a unique access key with each application.
    2. Enterprise Integrator
      1. Enterprise Service Bus – Processes API requests and can execute complex message patterns between the API Gateway and the Data Services Service.
      2. Data Services Service – Maintains connections to external resources such as Active Directory, Databases, File Systems, FTP servers.
    3. Analytics Server
      1. Analytics – Captures usage details for all managed APIs.

2      How to request the creation of an API.

To request a new API please open a SN@P request.  Currently we are using the Generic Request form but soon hope to have a dedicated form. 

  1. Navigate to https://princeton.service-now.com
  2. Select “Request Catalog”, then “Hardware & Software” and finally “Generic Request”.
  3. Use “APIs (Data Integrations) as the Business Service/Application.
  4. Use “New/Install” as the Type of Request.

 

We will then get back to you as soon as we can to fully explore the API requirements.

3      How to subscribe to an API

If you’d like to try it out you can subscribe to our public Active Directory API by following these steps:

  1. Go to: https://api-store.princeton.edu/store/ and login with your netid.
  2. Click on the green “Applications” tab on the left side of the screen.
  3. Click “+ Add Application” on the blue bar on the top of the screen.
  4. Enter a name (i.e. AD Test Application) and click “Add”.
  5. Click on the purple “APIs” tab on the left side of the screen.
  6. Click on “Active Directory”, select your application from the drop down list and then click “Subscribe” on the right hand side.
  7. Click the green “Applications” tab on the left side of the screen.
  8. Select your new application and click the “Subscriptions” tab to verify you’re subscribed.
  9. Click the Production Keys tab and clear all grant types except for “Client Credentials”.
  10. Click “Generate Keys” at the bottom, and then click “Show Keys” at the top.
  11. You can get the access token by running the second curl command which has your Consumer Key and Consumer Secrect base64 encoded.
  12. Or you can use the provided Access Token that you just generated to query the API.
    1. curl -k -X GET "https://api.princeton.edu/active-directory/1.0.0/users/full?sn=<Your Last Name>" -H  "accept: application/json" -H  "Authorization: Bearer <Access Token>"
  13. Or you can navigate to the API and select the “API Console” tab and click “Try It Now”.  (This is limited to netid only).

4      How to request access to the SDK and build your own APIs.

If you’d like to attempt to build your own APIs please use SN@P to contact us and we would be happy to mentor you through the process.

  1. Navigate to https://princeton.service-now.com
  2. Select “Incidents” and then “Create New”.
  3. Use “APIs (Data Integrations)” as the Business Service/Application.
  4. Use “Information/How to” as the Action.
  5. Fill in the rest of the form with the details of your request.

5      How to report a bug in an API.

If you’re experiencing a problem or would like an enhandement to an existing API please fill out a SN@P ticket with the relevant details.

  1.  Navigate to https://princeton.service-now.com
  2. Select “Incidents” and then “Create New”.
  3. Use “APIs (Data Integrations)” as the Business Service/Application.
  4. Select the appropriate Action.
  5. Fill in the rest of the form with the details of your request.

6      Contact Information

Please feel free to email us at Sisters@princeton.edu if you have any questions.

 

Back to top.