Summary

Once you've found the API you're looking for (and are pretty sure that you want to consume it), the next step will be to subscribe to it! To do this, you will need to be in the API Store. Now, you can do this the hard way–navigate to api.byu.edu/store, struggle through the Store's highly unintuitive searchbar, and finally (if ever) locate the API you just found in Developer Portal–or, you can do it the easy way. To do it the easy way, stay on (or go back to) the API page in Developer Portal, look at the right sidebar, and click the button that says View this API in the API Store.

After clicking View this API in the API Store, you will be brought directly to the particular API in the API Store. On the right side of the page, there will be a green button which says "Subscribe." If you do not see this button, it probably means that you are not logged in. Log in, and you should be able to see it. Directly above the Subscribe button, there will be two drop-down menus: one labeled "Applications" and one labeled "Tiers." From the drop-down menu labeled "Applications," select the application that you would like to use. Then, click Subscribe.

You will be asked if you would like to generate keys (by going to My Subscriptions) or stay on the page. Since you've been following this tutorial in order (right?), you should have already generated a consumer key for your application. However, when you originally generated keys, you also generated an access token. If more than an hour has passed since you clicked "Generate keys" (or, if this isn't your first time through, "Regenerate"), your access token has expired. To generate a new access token, push "Go to My Subscriptions." Then, click "Regenerate" for either the production or sandbox endpoint. If your access token has not expired, you can choose, "Stay on This Page." 

For more detailed instructions, see the step-by-step guide below.

 

Step-by-Step Guide

Step One: Navigate to the desired API in the BYU API Store

You can do this one of two ways:

  1. Find the API you're looking for in the Developer Portal, then click on the "View this API in the in API Store" button (at the right):

     
  2. Go to api.byu.edu/store, and enter the name of the API into the search bar at the top:

 

Note: If you're having trouble finding the API you're looking for, it might be that you're not logged in. Make sure to log in to the API Store. 

 

 

Step Two: Select an Application 

Each API page in the API Store looks something like the image below. In order to subscribe to the API, first select an application from the drop-down menu at the right. 

Note: If the "Applications" drop-down menu is not visible on your screen, it may be that you're not logged in. Make sure to log in to the API Store.

 

 

Step Three: Push "Subscribe"

Now that you've selected an application, there's only one thing left to do: find the green button which says "Subscribe" (it should be pretty close to the "Applications" drop-down), and push it!

 

Note: Once you push the "Subscribe" button, you will be notified that your subscription was successful. You will then be presented with the option to "Go to My Subscriptions" and generate keys, or to "Stay on this page" and use the Try-It feature. If you haven't generated keys yet for your application, or if you suspect that your access token has expired, you will probably want to "Go to My Subscriptions." Otherwise, you might as well "Stay on this page."