I have submitted an account request following the Getting Started Guide. How long does it take to get an account approved?

Within one working/business day you should have a response to your account application. We would like to provide service to campus staff, faculty, students, and affiliated enteties. To do this requires a bit of a review process for each request but is something that should be resolved fairly quickly. If you have not recieved information regarding an account request within a working day, please contact support@developer.ucsb.edu.

I noticed on the Getting Started Guide that I should create a Functional Account. Why shouldn't I create a personal account?

We strongly encourage the use of Functional Accounts because they aren't tied to an individual. That way the account can be shared with many people on a team. And, if someone is on vacation, then the team will still have access to make updates, monitor usage, or fix issues.

Of course, having an individual account for Testing and Proof of Concept work is also very useful. In that case, please feel free to request an individual account. But, please understand if we ask why you would like an individual account before approval.

When looking at My Apps, one my application is listed as Pending (with a grey circle around it) even though I requested Auto-Approved APIs (Academic Quarter Calendar, Students Lookups, etc). Why is it listed as Pending?

On the My Apps page, the overall status of all API Access requests is reflected along side the name of each application. The overall status can be very confusing and misleading. If any API Access that was requested is Pending then the overall status lists as Pending (which isn't always true).

To check on the status of individual API Access requests, try the following:

  • Expand out the application name so that you can see the application Keys.
  • Click on the APIs tab.
  • You can then scan through the list of APIs and discover which API Access requests were Approved and which are Pending.

If you have any Approved API Access requests that are Approved, then you can make calls to those APIs. This can be very confusing, because the Keys tab lists the Consumer Key (ucsb-api-key) is greyed out and struckthrough. This is a display problem within the Developer Portal and we apologize for it. The Consumer Key (ucsb-api-key) is actually valid and can be used.

  • Even though the Consumer Key (ucsb-api-key) is greyed out and struckthrough, it can be used on any API which has been Approved.
  • To use the key, you can double click on it and copy it from the page.

When looking at My Apps, one of my applications is listed as Revoked (with a red circle around it). Why is it listed as Revoked?

On the My Apps page, the overall status of all API Access requests is reflected along side the name of each application. The overall status can be very confusing and misleading. If any API Access that was requested is Revoked then the overall status lists as Revoked (which isn't always true).

To help remediate the incorrect display you can:

  • Expand out the application name so that you can see the application Keys.
  • Click on the APIs tab.
  • You can then scan through the list of APIs and discover which API Access request was Revoked.
  • Once you know which API Access was Revoked, you can then click on Edit "application name".
  • In the pop-up menu, scroll through the list of APIs and uncheck the API which was Revoked.
  • Scroll to the bottom of the pop-up menu and click Save App.

Your application should no longer have the Revoked status; if it does, please continue to remove API Access requests that are in the Revoked status. Alternatively, if all API Access requests are in the Revoked status, then the application may have been Revoked.

Where can I submit an Application Approval Request?

To start the process please submit an Application Approval Request form. It will begin a workflow process to review and approve your application for use with Campus APIs. 

Application Approval Request

If you have further questions please email support@developer.ucsb.edu.

I have developed an API and would like to publish it in Apigee. What is the process that I need to follow?

To start the process please submit an API publish form. It will begin a workflow process to approve and publish your API in Apigee's gateway. 

API Publishing Request

If you have further questions please email support@developer.ucsb.edu.

When using an API that required Access Approval or is Private, I sometimes get the error message that of "message": "Authorization has been denied for this request.". How do you fix that?

Many of the APIs that require Access Approval or are Private require secondary authentication information. This is usually a Basic Authorization Header (a base64 encoded ucsbNetId:password combination) which will be used by the backend system to authenticate who or what application is calling into the API service. As a client you would be aware if a system required secondary authentication information, as you would be asked to provide a UcsbNetId when applying for access.

When the service is called, if the UcsbNetId/Password combination can't be authenticated successfully, or the UcsbNetId hasn't been authorized to access the API a common error message of "message": "Authorization has been denied for this request." may be replied.

Some common mistakes that lead to this error message are:

If you are sure you're doing the first two above, please reach out to support@developer.ucsb.edu to see if your application's ucsbNetId can be added.

Why do the APIs have different version numbers? I can see that Student Record Code Lookups is version 1.1, but Academic Quarter Calendar is only at version 1.0? (as of 2018/07/20)

Each API is provided and maintained by different departments and teams on campus. To make things more flexible for those groups we've decided that it would be best to allow for each team to manage their API versioning independently. So, one API may have a version of 1.0 another API may be at version 2.2.

However, all versioning is done by a set of guidelines and standards. So, how the major version number is listed in the url (/v1, etc) and how the minor version numbers can be specified in the headers (ucsb-api-version) is standardized across all APIs.

As a sidenote, please also check the headers returned in the responses. Sometimes they can indicate if an API version is set to be decommissioned (api-deprecated-versions).

Fill out the Suggest an API form or see the Ideas for APIs for the planned APIs.

Let us know your changes ideas at:  support@developer.ucsb.edu