Trying to login to school my school API

John Trovato

Hi, I am a student from Woodlawn School and am currently trying to pull information from my school accounts page. (The information being my homework.) Though my first road block is signing in I use the blackbaud api page (

)

It tells me to use: https://{school}.myschoolapp.com/api/authentication/login

So… I type in https://woodlawnschool.myschoolapp.com/api/authentication/login and I get a 404 error. Yes my school is registered with blackbaud, yes I know the spelling is correct. What might be the problem?

Bryna Gleich

Hi John,

The ON API is an older “legacy" API. We don't recommend using it. We're not adding any new endpoints to it. People who use it go to a different online web forum too.

We recommend all new development use SKY API for schools instead. SKY API is what this user forum is for. SKY API for schools is a newer API. We're actively adding new endpoints and updates to existing endpoints for SKY API. The SKY API is replacing ON API.

Information about SKY API is at

Are you working with a teacher or school administrator to help you with your app project? A school administrator needs to setup some things on their end to grant access. Without access from the admin, you can't pull data through any of the APIs.

The school administrator would likely want to set up a “sandbox” for safe practice too, instead of using real live data, to test the app you're working on. If it works well in the sandbox, then they might enable it for real.

I think what some other student developers do is pair up with a teacher or admin. The teacher/administrator gets real access to the API and does “code review” for the student developer. So when the student has an app to test or to enable, the teacher/admin is involved. The student's work still gets to become real and live; it just goes through the teacher/admin in the process.

This gives the school extra reassurance that you only see the data you have rights to see, and can't see data from other students or staff.

Have the teacher/administrator post here about API access for SKY and we'll troubleshoot more from there.

Out of curiosity and so we can be ready to help, what is the app hoping to do? (view assignments, submit them, etc).

Thanks!

John Trovato

Dear Dr/Ms/Mrs Gleich,

Thank you for replying! The information I am trying to use is just the Information of assignments given. (There is a tab for assignments for my class and I want to pull that data. Specific for my account.)

I have made a swiftui program already that when fed the proper link (api/json link I'm not sure the correct terminology), it can read the data and then print it out for me.

I can open the api link I am trying to access through network on chrome. (This means I can access the said data I am trying to access.) The issue is though incognito tabs are unable to due to the error:

{"Error":"REQUIRED_DATA: Must provide a token value for parameter 't' on all authenticated calls.","ReferenceId":null,"ErrorType":"REQUIRED_DATA","ErrorId":13,"ErrorClass":null,"ErrorProperty":null}

Which makes sense, that just means though if I try to access it from xcode, it will be simillar to that of an incognito tab. I want to know how to provide my token as a student or if there is any way. If not that is completely fine and I believe I could work with an admin.

Thanks, John Trovato

Bryna Gleich

{"Error":"REQUIRED_DATA: Must provide a token value for parameter 't' on all authenticated calls.","ReferenceId":null,"ErrorType":"REQUIRED_DATA","ErrorId":13,"ErrorClass":null,"ErrorProperty":null}

Which makes sense, that just means though if I try to access it from xcode, it will be simillar to that of an incognito tab. I want to know how to provide my token as a student or if there is any way. If not that is completely fine and I believe I could work with admin…

Hi John,

Thanks for the background info.

I believe the error message is referring to the Token that's from Step 4 of

for the ON API.

It's something that a platform manager (usually one of the teachers, school administrators, or IT staff at the school) configures for the developer (in this case you). So you'll definitely need to work with that person at the school to do that. And you'll need a “sandbox” to test it in.

The token is not the same as your username and password, so it's not something you have as a student.

Since this is a new app, I recommend bulding it over on the SKY API instead of the ON API, but you'll still need a platform manager (teacher, admin, etc) for that API too.

I know we've had at least one other school whose computer science teacher had a class of students who also wanted to develop with the SKY API. So you're in good company as a student developer.

Hypothetically, you could request access to a sandbox (also known as a cohort database environment) without going through the school, but it would be a generic sandbox shared with other third party developers and thus not connected to your specific school's data in any way. It would enable you to pull data for “Demo Student” for example, rather than for yourself, John Trovato. So you could test an idea and app in the demo environment but it would eventually need the school admin to make it enabled for Woodlawn.

Good luck and happy coding!

PS. Mrs, Ms, or just Bryna.

Bryna Gleich

For additional context, the other school and teacher (Hassan Singer) discussed it in this user community thread.

When you figure out who is the correct teacher/admin at Woodlawn, they might want to reach out to Mr. Singer to compare tips and tricks regarding student developers with the API.

John Trovato

Dear Mrs. Gleich,

Sorry for a late response.

I'm trying to figure out how to use the sky api, because there's no coding happening at my school, this is more of a me project. Is there any guides on how to use the sky api, I am having a hard time figuring it out.

As well, my teacher that I may get assistance from, I want them to be hassled the least amount possible because I'm not sure they know this type of coding.

Here is my main question: is there anyway to use sky api on xcode? (Or just other programs.) Because all I need is the api link (I need a way to login in from code to get a link, is there a way to do that without using blackbauds application and only using the api?)

Thanks, John Trovato

John Trovato

Update on the question:

I just mean is there a tutorial on how to use the api in action to get a link. Sorry the question was worded badly

Steven Cinquegrana

Hi John,

I've messaged you privately about our SKYLib•NET SKY API Code Library and SDK. If you want to get up and going as quickly as possible, and have access to Visual Studio (there's a free version available to education), this might be a solution for you.

Oops; I forgot to mention that SKYLib is free to use in rate-limited mode.

Cheers,

Steve Cinquegrana | CEO and Principal Developer | Protégé Solutions

Bryna Gleich

Is there any guides on how to use the sky api, I am having a hard time figuring it out.

There is a tutorial

But the SKY API needs Blackbaud's application and authentication (login) to work.

--

A lot of people who use SKY API also use SKY UX. For example, people use SKY API + SKY UX to make custom additions to their Blackbaud applications.

But SKY UX doesn't need Blackbaud's APIs and SKY UX doesn't need Blackbaud's applications either.

SKY UX is open source, hosted in git hub, has design patterns for user interface experiences, and features Angular components.

--

Since there isn't coding happening at your school and the teacher doesn't know this type of coding, I would recommend shifting your focus.

Instead of focusing on Blackbaud's SKY API, maybe try SKY UX + other APIs. Or try xcode + other APIs.

--

For example, I know someone who hates driving in traffic and so he used SKY UX plus the South Carolina Department of Transportation's traffic cameras

to make a page that enabled people to more easily preview their specific commute to work, to the local beaches, or to evacuate from a hurricane.

--

I also know someone who used SKY UX + inspiration from things like

and

and

to make a page about being prepared for local emergencies and severe weather events. When I log in, it shows all the maps zoomed in to my home address so I can see how my home is affected.

--

I recommend:

Rather than trying to use SKY API to build an app that shows things like homework, school events, etc. (which people can already see in the Blackbaud Education Management application and your school's web site), instead maybe build an app or website that does something your school community doesn't have yet.

Then once that's working, if you're still interested in SKY API, maybe the teacher will have had time to invest in learning more about SKY API, and the school could consider connecting what you've made to the school more officially.

You could use SKY UX if you're interested in that, or XCode, or anything you like.

--

Some ideas to try:

• A study guide app or study game for your favorite class or subject

• A trivia game about your school and community

• A digital “escape room” game themed to your local community or school

• An interactive map and score keeper for an unofficial disc golf “course” (for example, par 4 with a tee off at the library entrance and a hole at a specific tree in the park next door).

• An app for a local charity, like for volunteers to walk dogs at a local shelter

• An interactive educational tour route, scavenger hunt, or geocache site for your school, a local nonprofit, or local community

• A game app like “The amazing race” themed to your local school or community

• An “enchanted object” for your home, school, community, or favorite non-profit

(That's like “the internet of things." There is a book called “Enchanted objects” about this. For example, inspired by Bilbo's sword in Lord of the Rings, which glowed blue when orcs are near, an “enchanted” umbrella might have LED lights that turn blue when rain is in the weather forecast. Or, for example, a lid for medications that will change the lights or send a phone message if someone forgets to take their medicine on time.)

--

Consider APIs for

• the Smithsonian,
• the Library of Congress
• NASA
• Google maps
• Google photos
• Google search
• Google translate
• YouTube
• Amazon Alexa
• Flashcard generators
• Crossword generators
• Word search generators
• Local government services
• Digital libraries
• Weather services (like Windy)
• IMDB (internet movie database)
• Instagram
• Shazam
• A thesaurus or dictionary
• Event services
• TikTok
• Speech to text
• and more.

This site lists many free, public APIs (both funny and serious) that don't need logins:

John Trovato

Dear Mrs. Gleich,

I'm having a hard time understanding this conversation, I would like to restart to make it a bit easier to understand for me.

My problem is my teachers like to post assignments in different places. It might be google classroom, it might be blackbaud, etc.. I have an application already made with swiftui on xcode. (I am not making a new application on SKY API, though I have signed up for the subscription.) The point of it is to put all my assignments in one place.

My problem is that I have a link that I want to pull data from, but can't access it. (I can access it through networking while on chrome, however when doing it through xcode, it treats it as an incognito tab, so it doesn't recognize me.)

This is a link for example that I can access while on chrome because it recognizes that I am a student, however the moment I use an incognito tab or use xcode, it can't recognize that I am a student. So it gives me this error instead of the json file:

{"Error":"REQUIRED_DATA: Must provide a token value for parameter 't' on all authenticated calls.","ReferenceId":null,"ErrorType":"REQUIRED_DATA","ErrorId":13,"ErrorClass":null,"ErrorProperty":null}

I don't mind if I need to use an old api, as long as it will work because I won't be using this for much longer. How do I encode that I am a student, or what API should I use for this, being on swift. Literally all I need is the json file and access to it.

If I need a teacher to give me ability to do this, how would the admin give the permissions?

I'm so sorry for all of my confusion, I seriously appreciate the help.

Thanks, John Trovato

Bryna Gleich

My problem is my teachers like to post assignments in different places. It might be google classroom, it might be blackbaud, etc.. I have an application already made with swiftui on xcode. The point of it is to put all my assignments in one place.

I can understand your desire. However, it isn't possible do to that without the school admin. This is due to security.

You can't pull your school assignments from Blackbaud on your own. You can log into the Blackbaud app your school uses. But you can't export the information from Blackbaud to xcode complete it in your own app and then send it back to Blackbaud on your own.

My problem is that I have a link that I want to pull data from, but can't access it. (I can access it through networking while on chrome, however when doing it through xcode, it treats it as an incognito tab, so it doesn't recognize me.)

You have to be logged in. When you're incognito, you aren't logged in.

I don't mind if I need to use an old api, as long as it will work because I won't be using this for much longer. How do I encode that I am a student, or what API should I use for this, being on swift. Literally all I need is the json file and access to it.

If I need a teacher to give me ability to do this, how would the admin give the permissions?

You can't do what you're wanting to do. You don't have the security rights.

A teacher/admin probably won't give you this right either. See what I posted previously about tokens and sandboxes.

Your school can set things up to make your homework experience easier (such as enabling a single sign on, SSO between the Blackbaud app and Google Classroom).

But you can't set it up as a student. You don't have that sort of security clearance.

John Trovato

Dear Mrs. Gleich,

I want to clarify that I am not exporting anything back to blackbaud. I am only collecting data for an application that I am making. So that I can just look at the data on my app. It isn't sending anything back out.

Is what I am trying impossible even if I had admin clearance? Because I have the Admin working with me now.

(When I said encode, I just meant use swiftui encoding system to login. But I'm guessing that isn't possible, just was a shot in the dark.)

Thanks, John Trovato