APIS

Note

To make development easier, we advise you to consider requests over urlib or any other HTTP library in Python.

Account Resource

GET /private/account/signup

Creates a new user on Aurum and other subsystems in Graphyte (GCS and Natrium).

Example request:

curl --data "username=<username>&password=<password>&masteru=<masteru>&masterp=<masterp>"
  https://example.com/aurum/private/account/signup -k

POST /aurum/private/account/signup HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 201 OK
Vary: Accept
Content-Type: text/html; charset=UTF-8

{
    "access_key": "82865e3f0df5fcc9748a3a354c220d7e",
    "status": "201",
    "reason": "User exampleuser created."
}

Query Parameters:  

• username – username of the new account
• password – password of the new account in plaintext
• masteru – administrator username
• masterp – administrator password in plaintext

Status Codes:

• 201 – account created in all subsystems
• 400 – password is less than six characters
• 409 – username already exists in Aurum
• 500 – unknown internal service error

Exercise Resource

POST /api/exerise

Creates a new exercise resource.

Example request:

curl --data "username=<username>&password=<password>&repo=<repo_url>&exercise_id=<exercise_id>"
  https://example.com/aurum/api/exercise -k

POST /aurum/api/exercise HTTP/1.1
Host: example.com
Accept: application/json

Example response:

HTTP/1.1 201 OK
Vary: Accept
Content-Type: text/html; charset=UTF-8

{
    "access_key": "19312b8a9cd49af331c8adc0d65ddfd1",
    "exercise_id": "61ee6bd343a3bb3f7215b8ef906d1c35"
}

Query Parameters:  

• username – instructor username
• password – instructor account password in plaintext
• repo – full path to the repo (https://bitbucket.org/user1/repo1, ssh://hg@bitbucet.org/user1/repo1)
• exercise_id – a predefined exercise-id (optional)

Status Codes:

• 201 – (possibly new) exercise record is created
• 400 – user not found
• 401 – authentication failed