Skip to content

Instantly share code, notes, and snippets.

@thatguyintech

thatguyintech/GMATClub User Authentication Docs.md

Last active December 1, 2017 20:26
Show Gist options
  • Save thatguyintech/36b6c0ad762361658ba767d8b5e6712e to your computer and use it in GitHub Desktop.
Save thatguyintech/36b6c0ad762361658ba767d8b5e6712e to your computer and use it in GitHub Desktop.
Download ZIP
Raw
GMATClub User Authentication Docs.md

Magoosh Support API Documentation

Authentication

All requests should include a 'Authorization' header with an API key which will be provided. Headers['Authorization'] = "Token token=abcabcabc"

If you don't have a token, email zack@magoosh.com to get one!

All responses will be provided in JSON format.

API testing can be done on the development server. Swap out the gmat.magoosh.com portion of the API endpoint with gmat.preview.magoosh.com. Any actions performed on the preview endpoint will NOT change production information.

Users

GET: https://gre.magoosh.com/api/users/add?email=test@test.com&password=gmat&password_confirmation=gmat

Parameters:

  • email: (required) the student's account email.
  • password: (required) the student's account password.

Note: special characters in the email must be URL encoded. zack+1@magoosh.com is not work properly. It would need to be formated like: zack%2B1@magoosh.com

Another note: sometimes, when we think the email might have a typo, like in hello@gmaul.com, we may deny the account creation, and in that case the user would either have to correct the typo or just try a second time

Successful response:

nothing will be returned except for a 201 created HTTP status

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