Canvas OneStop REST API

A simple API to integrate Canvas, Stripe, and more.

BASE API URI: api.canvasadmin.educative.tech

Auth Routes

Register a new user with the One Stop App db

POST

Endpoint: /api/auth/register

Expected Params:

{
    "email": string,
    "first_name": string,
    "last_name": string,
    "user_name": string,
    "password": string
}

Example Response:

{
    "message": "User registered successfully",
    code: 201
}

Login user on the One Stop DB

POST

Endpoint: /api/auth/login

Expected Params:

{
    "email": string,
    "password": string
}

Example Response:

{
    "access_token": access token,
    "refresh_token": refresh token,
    "user_id": {
        "id": 1,
        "first_name": John,
        "last_name": Greg,
        "user_name": JG2015,
        "email": [email protected],
        "is_active": true,
        "is_admin": false,
        "is_verified": true,
        "created_at": 2015/03/31
    }
    "message": "Login successful"
    code: 200
}

Get current user information.

GET

Endpoint: /api/auth/me

Auth headers required

Expected Params:

{
    None
}

Example Response:

{
    "id": 1,
    "username": JG2015,
    "email": [email protected],
    "first_name": John,
    "last_name": Greg,
    "verified": true,
    code: 200
}

Verify user registration before purchases can happen.

POST

Endpoint: /api/auth/verify-code

Auth headers required

Expected Params:

{
    "203134"
}

Example Response:

{
    "status": "success",
    "message": "User verified successfully"
    code: 200
}

Check to see if there is an existing verification request

POST

Endpoint: /api/auth/check-verification-request

Auth headers required

Expected Params:

{
    "email": string
}

Example Response:

{
    "status": "found",
    "message": "Verification request found"
    code: 200
}

Create a new user verification request will send a verification code email

POST

Endpoint: /api/auth/create-user-verification-request

Auth headers required

Expected Params:

{
    "email": string
}

Example Response:

{
    "message": "Request code sent successfully"
    code: 200
}

Create password reset verification and send code via email

POST

Endpoint: /api/auth/password-reset-verification

Expected Params:

{
    "email": string
}

Example Response:

{
    "message": "Request code sent successfully"
    code: 200
}

Verifies password reset verification code and changes pw if code is correct

POST

Endpoint: /api/auth/verify-pw-reset

Expected Params:

{
    "verificationCode": string,
    "new_password": string
    "email": string,
}

Example Response:

{
    "status": "success",
    "message": "User verified successfully"
    code: 200
}