Introduction

This documentation walks through how to connect a client system to the School Info API. We'll use the free tool Postman to test your credentials and view example responses.

You should be familiar with RESTful API concepts.

Credentials & Access

If you haven't done so already, now is the time to get your credentials from ContactUs@ScholarSnapp.org. Even if you're already a Scholar Snapp API client, you will need credentials specifically provided for this system.

The system uses JSON Web Token (JWT) authentication. If you're reading this, you're probably familiar with JWT, but, if not, it's RFC 7519, with a pretty good overview here and a Wikipedia entry chock full of references to further information here.

You'll be issued a Client ID and a Client Secret.

Connecting

Connecting to the API is straightforward. If you've used RESTful APIs and JWTs, the steps will look familiar. The steps can be summarized:

Detail on each step follows.

Step 1. Use your Credentials to Obtain a Token

Many code libraries provide a method to access a JWT token. We'll go through the steps so you can see what's going on.

POST       {{ server }}/api/authApp
Header:    Content-Type: application/json

{
     "clientid": "your-credentials-here",
     "secret": "Y0ur_ap1_s3cr3t_h3r3"
}

Presuming your credentials are valid, you'll receive back a JWT:

{
    "success": true,
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjbGllbnRJZCI6ImljLXNjaG9vbC1hZG1pbi1zdGFnZSIsImNsaWVudE5hbWUiOiJJQyBTY2hvb2wgQWRtaW4gU3RhZ2UiLCJpc0FkbWluIjp0cnVlLCJpYXQiOjE1NjAxMDUzMjUsImV4cCI6MTU2MDE5MTcyNX0eyJjbGllbnRJZCI6InlvdXItY3JlZGVudGlhbHMtaGVyZSIsImNsaWVudE5hbWUiOiJZMHVyX2FwMV9zM2NyM3RfaDNyMyIsImlhdCI6MTU2MDEwNTMyNSwiZXhwIjoxNTYwMTkxNzI1fQ.rr8cMZ0HalZGWudDJ7kyRwvNNOnj-kNPHFczKBN69Z3k9fuhQFZI5F-PYfQpWFP3m2GV4lE4PcOYMokXmLJM"
}

Step 2. Call the API Using your Token

Step 3. Review the Results

T

Next Steps

...Links to More Documentation, Swagger advice if applicable, etc. ...