Skip to content

Instantly share code, notes, and snippets.

@abrahamsangha

abrahamsangha/API.md

Last active December 21, 2015 06:29
Show Gist options
  • Save abrahamsangha/6264875 to your computer and use it in GitHub Desktop.
Save abrahamsangha/6264875 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
API.md

API Reference

The Dev Bootcamp (DBc) API is designed on REST principles. Our approach entails simple, descriptive URLs used to obtain resources. We use HTTP features, such as the HTTP verb GET, HTTP Secure, and HTTP response codes for API errors. Successful API calls will result in JSON responses. Hopefully these engineering choices enable developers to maximize their productivity.

The Dev Bootcamp API allows authenticated users to access select data such as a student's social media urls, a cohort's Socrates submissions, or a Dev Bootcamp location's total number of students. This data can be used to create applications that leverage DBc info into useful creations limited only by a developer's imagination.

API Authentication and Authorization

The DBc API uses OAuth 2.0 through DBc Auth to authenticate users. Authenticated users are provided an API key, which must not be shared and is used by its inclusion in the HTTP headers to authorize calls to the API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment