Skip to content
Liang Gao edited this page Apr 15, 2015 · 7 revisions

Welcome to the Torpedo REST API documentation.

Quick Refrence

The REST APIs provides programmatic access to read and write SAS (Student Attendance System) data. Add a new entry, read student information and course data, and more; responses are available in JSON.

For more information about a particular endpoint, click on its name under the sidebar header. You’ll be taken to the endpoint’s documentation page, which includes what query parameters the endpoint will accept, what the JSON object’s parameters will be in the response, and an example query/response.

This documentation is for our beta version of the REST API, version 0.1

Base URL

All URLs referenced in the documentation have the following base: https://bhsas.herokuapp.com/v1

Overview

Below are the documents that will help you get going with the REST APIs as quickly as possible

About REST (REpresentational State Transfer)

We designed the Torpedo API in a very RESTful way, so that your consumption of it is simple and straightforward.

Clone this wiki locally