Sparky

Sparky E-Learning API Documentation

bash

base_url=https://impressed-birdie-sparkytech-76064b97.koyeb.app/v1

Auth

POSTsign-up

https://impressed-birdie-sparkytech-76064b97.koyeb.app/v1/auth/register

Bodyraw (json)

json

{
    "email": "ayobamidele006+26@gmail.com",
    "name": "Ayobami41",
    "password": "Haywon007@"
}

Example Request

curl

curl --location 'localhost:3000/v1/auth/register' \
--data-raw '{
    "email": "ayobamidele006+8@gmail.com",
    "name": "Ayobami7",
    "password": "Haywon007@"
}'

201 Created

Example Response

json

{
  "success": true,
  "message": "Activation has been sent to your email ayobamidele006+8@gmail.com",
  "activationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Im5hbWUiOiJBeW9iYW1pNyIsImVtYWlsIjoiYXlvYmFtaWRlbGUwMDYrOEBnbWFpbC5jb20iLCJwYXNzd29yZCI6IiQyYiQxMCQzTFNkN2JDeWd3a1dKRkUubDZsbUZ1SERCbGoxdW5SVnBBQk9FT2kzM3Z0L2RDUTNObmpoQyJ9LCJhY3RpdmF0aW9uQ29kZSI6IjM4ODciLCJpYXQiOjE3MTUxMTQ4NjgsImV4cCI6MTcxNTExNTQ2OH0.BobV3rADIpHz19aQupk3Vb779lOUD8LdwUyGhi1_NN8"
}

X-Powered-By

Express

Access-Control-Allow-Origin

Content-Type

application/json; charset=utf-8

Content-Length

459

ETag

W/"1cb-U/U9qseBWgOhuufv97VBT6NQAPs"

Date

Tue, 07 May 2024 20:47:48 GMT

Connection

keep-alive

Keep-Alive

timeout=5

POSTverify-user

localhost:3000/v1/auth/verify

Bodyraw (json)

json

{
    "activationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Im5hbWUiOiJBeW9iYW1pNCIsImVtYWlsIjoiYXlvYmFtaWRlbGUwMDYrMkBnbWFpbC5jb20iLCJwYXNzd29yZCI6IiQyYiQxMCRZTDBZL3gvd055QTlKZlpmS3RiR3l1ODcvU25GU3JOaUhzRjQwWXZFTnhjYWdPTlRxTTl1QyJ9LCJhY3RpdmF0aW9uQ29kZSI6IjU2MDUiLCJpYXQiOjE3MTU0NzczMjksImV4cCI6MTcxNTQ3NzkyOX0.aAF1MFDmoa3c3IGyeeqsUEEg_1UHvZ-jD3waDy3zUtk",
    "activation_code": 5605
}

Example Request

curl

curl --location 'localhost:4000/v1/auth/verify' \
--data '{
    "activationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7Im5hbWUiOiJBeW9iYW1pNyIsImVtYWlsIjoiYXlvYmFtaWRlbGUwMDYrOEBnbWFpbC5jb20iLCJwYXNzd29yZCI6IiQyYiQxMCQzTFNkN2JDeWd3a1dKRkUubDZsbUZ1SERCbGoxdW5SVnBBQk9FT2kzM3Z0L2RDUTNObmpoQyJ9LCJhY3RpdmF0aW9uQ29kZSI6IjM4ODciLCJpYXQiOjE3MTUxMTQ4NjgsImV4cCI6MTcxNTExNTQ2OH0.BobV3rADIpHz19aQupk3Vb779lOUD8LdwUyGhi1_NN8",
    "activation_code": "3887"
}'

201 Created

Example Response

json

{
  "success": true,
  "message": "User created successfully",
  "user": {
    "id": "ab805192-c30a-46ba-8327-d69e53e31144",
    "name": "Ayobami7",
    "email": "ayobamidele006+8@gmail.com",
    "role": "user",
    "isVerified": false,
    "updatedAt": "2024-05-07T20:48:35.080Z",
    "createdAt": "2024-05-07T20:48:35.080Z",
    "_id": {},
    "avatar": null,
    "courses": null
  }
}

X-Powered-By

Express

Access-Control-Allow-Origin

Content-Type

application/json; charset=utf-8

Content-Length

311

ETag

W/"137-FXuAE6mk/HYRLEwJvDTCVvmylYg"

Date

Tue, 07 May 2024 20:48:35 GMT

Connection

keep-alive

Keep-Alive

timeout=5

POSTlogin

https://impressed-birdie-sparkytech-76064b97.koyeb.app/v1/auth/login

Bodyraw (json)

json

{
    "email": "ayobamidele006+8@gmail.com",
    "password": "Haywon008@"
}

Example Request

curl

curl --location 'localhost:3000/v1/auth/login' \
--data-raw '{
    "email": "ayobamidele006+8@gmail.com",
    "password": "Haywon007@"
}'

200 OK

Example Response

json

{
  "success": true,
  "message": "Login Successful",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImF5b2JhbWlkZWxlMDA2KzhAZ21haWwuY29tIiwiaWF0IjoxNzE1MTE1OTg0fQ.RiUVgHKlq1KNzhpnuPCw2pBXXhibM94MCg22KO2UjWs",
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJhYjgwNTE5Mi1jMzBhLTQ2YmEtODMyNy1kNjllNTNlMzExNDQiLCJpYXQiOjE3MTUxMTU5ODR9.lVvLiuR5dBQ8brEEbDDVgjczUpvZmlkOwpUGsHuc7F4"
}

X-Powered-By

Express

Access-Control-Allow-Origin

Set-Cookie

refreshToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJhYjgwNTE5Mi1jMzBhLTQ2YmEtODMyNy1kNjllNTNlMzExNDQiLCJpYXQiOjE3MTUxMTU5ODR9.lVvLiuR5dBQ8brEEbDDVgjczUpvZmlkOwpUGsHuc7F4; Max-Age=604800; Path=/auth/refresh_token; Expires=Tue, 14 May 2024 21:06:24 GMT; HttpOnly

Set-Cookie

accessToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImF5b2JhbWlkZWxlMDA2KzhAZ21haWwuY29tIiwiaWF0IjoxNzE1MTE1OTg0fQ.RiUVgHKlq1KNzhpnuPCw2pBXXhibM94MCg22KO2UjWs; Max-Age=604800; Path=/auth/login; Expires=Tue, 14 May 2024 21:06:24 GMT; HttpOnly

Content-Type

application/json; charset=utf-8

Content-Length

404

ETag

W/"194-v5Tb6/du2ywGpkL9UiCdVXpYvsE"

Date

Tue, 07 May 2024 21:06:24 GMT

Connection

keep-alive

Keep-Alive

timeout=5