Getting Started

The Signal Kit API provides school districts with the ability to communicate with their population. As you get started, here are a few basic guidelines that apply to this collection of API endpoints.

Authentication

In order to interact with the Signal Kit API, your requests must be authenticated using the OAuth2 workflow. You can get your API key and secret from our support team. These credentials will give an authenticated user access to control the district. Please keep them safe. For example, you wouldn’t want to do something like what I’ve done below and publish your key and secret somewhere people can easily find it.

key: Pu5NLC6ocAVObQ8TCYwrZh1Fs2lZDZdHP4GTRJNL

secret: nrGiICFOFKitut2Ho4Kv8mxKqay55UKVDr9M28JDSIL0ufrWFbDEiM8K2frFxhZEGyi30G6IfhlHbAQ9ccZrd4FeniRXwETcMkt2ClLnLQjWIl4Cfz3WuJuHhVoCVYn2

Thankfully these are for a district that we’ve setup just for this page. Enter the values from above in the Settings tab below and then click “Send” to see the access_token retrieval in action.

Getting An Access Token
Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
key
secret

Once you have this Bearer access_token, you just need to add an Authorization header to your API requests. If you hit “Send” above, just pull the access_token from the response and enter it in the Settings tab below in the access_token field. Try removing it to see how the endpoint responds when this value is not set or incorrect.

Using An Access Token
Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
access_token

Request Format

Unless otherwise noted, Signal Kit API endpoints accept and return data using the application/json content type.