Getting Started

Tim Kramar

I'm trying to get started with some simple API calls but when I attempt to try the API, I get an error about connection to my environment. I've tried to build an application, but i'm missing some key pieces (like Redirect_uri) that I have no clue how to do, and the documentation on Getting Started doesn't mention. What am I missing here? I've tried to work with support, but they refused to help claiming they don't do development. I'm not really trying to develop, just set up the connection to test the API.

My end goal is to automate nightly pulls of our school's OneRoster enrollments CSV.

Todd DeSchuiteneer

Hi @Tim Kramar , I apologize for your support experience. It looks like you may have asked the Associate for some specific information they were not able to provide. I've had a look at your settings and everything seems to be in place.

Are you able to use the “Try It” feature on the endpoint listings?

That should tell us if you are correctly associated with your environment.

Another question, are you trying to connect to SKY API or OneRoster via OAuth 2.0?

Tim Kramar

@Todd DeSchuiteneer At the time, I wasn't even sure what I was trying to do. After spending hours yesterday exploring, I realized I needed the OneRoster API. An hour after that I found the Try It doesn't work for that API. I found another way to test via Postman (as mentioned in the Authorization instructions for OneRoster), and I get the reply message “Resource Not Found”.

Todd DeSchuiteneer

@Tim Kramar yes, currently the “Try It” feature does not function with the OAuth 2.0 OneRoster Endpoints. You would need to test out those connections in an application such as Postman.

If you don't need the OAuth 2.0 connection type, creating a OAuth 1.0 connection in the application is a bit easier to set up and test in Postman.

Here is the documentation on setting up that connection:

Tim Kramar

@Todd DeSchuiteneer I was able to get the authentication down with the Bearer token through Postman. When I tried the Get request it came back with the Resource Not Found message. Am I messing up the call? With the OAuth1.0, what would be the “School Name”? The actual school name didn't work. Would it be the environment name?
Bottom line is I'd like a nightly export the Enrollments table and get it into a CSV. Nothing seemingly too crazy.

Tim Kramar

@Todd DeSchuiteneer So I figured out how to retrieve a token via Postman, and make the Get call to retrieve the data. How would I go about automating that pull?

Todd DeSchuiteneer

@Tim Kramar after you receive your bearer token are you making the call to

The authorization URL and the Call urls are different so just making sure.

regarding OAuth 1 schoolname, that would be your myschoolapp url. This article might help explain it:

Todd DeSchuiteneer

@Tim Kramar you may want to ask that in a new post. I am unable to answer that for you.