Skip to content

Latest commit

 

History

History
949 lines (684 loc) · 21.2 KB

API-V1.md

File metadata and controls

949 lines (684 loc) · 21.2 KB
Raw

API V1 Documentation

Table of Contents

Common Specifications

HTTP status Codes

The following HTTP status codes are returned by the API

Status Code Description
200 Request successful
202 Request has been accepted for further processing, which will be completed sometime later.
400 Problem with the request
401 Valid JWT token is not specified
404 Request / Route is not found
405 Request method is invalid
500 Error on the internal server

Response structure

The following JSON data is returned in the response body

Property Type Description
status String Give the result of the request that it's success or not
code Number Request status code. Note that this code does not related to HTTP status code
response.message String Result summary
response.data Object (Optional) Provide useful data for processing

Authentication

Authentication/Create

Create non-activated user

HTTP request

POST /api/v1/auth/create

Request headers

Request header Description
Content-Type application/json

Request body

Property Type Required Description
authentication.user String Required Username (unique)
authentication.pass String Required Password
profile.fullname String Required Fullname of user

Response

Returns a 200 HTTP status code and a JSON object with the following data.

Property Type Description
response.data.user.activation.ref String Reference code for user activation
JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "user created",
    "data": {
      "user": {
        "activation": {
          "ref": "30st2lkt"
        }
      }
    }
  }
}

Authentication/Login

Request authenticated JWT token

HTTP request

POST /api/v1/auth/login

Request headers

Request header Description
Content-Type application/json

Request body

Property Type Required Description
authentication.user String Required Username
authentication.pass String Required Password

Response

Returns a 200 HTTP status code and a JSON object with the following data.

Property Type Description
response.data.token String JWT token which being used for authentication
response.data.user.id String User ID
response.data.user.user String Username
JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "authenticated",
    "data": {
      "token": "JWT eyJhbGciOiJIUzI1NiIsInR5cC...",
      "user": {
        "id": "5c4ddcd75dfafe51104f6521",
        "user": "rayriffy"
      }
    }
  }
}

Authentication/Activate

Acticate user

HTTP request

POST /api/v1/auth/activate

Request headers

Request header Description
Content-Type application/json
Authorization JWT {Administrator JWT token}

Request body

Property Type Required Description
activation.ref String Required Activation reference code

Response

Returns a 200 HTTP status code and a JSON object with empty data.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "user activated"
  }
}

Announcement

Announcement/Create

Create announcement and notify to devices

HTTP request

POST /api/v1/announce/create

Request headers

Request header Description
Content-Type application/json
Authorization JWT {Administrator JWT token}

Request body

Property Type Required Description
announce.message.title String Required Announce message title (will also appear as push notification title)
announce.message.body String Required Announce message body
announce.to Array Required Array of subscribed topic push notification to sent

Response

Returns a 202 HTTP status code and a JSON object with announcement data.

JSON 
{
  "status": "success",
  "code": 202,
  "response": {
    "message": "announce created and being notified to specified users",
    "data": {
      "announce": {
        "id": "sxr409qi6bf7k78n9q1lll7h",
        "date": "2019-02-04T22:44:30.652Z",
        "message": {
          "title": "TPJR",
          "body": "8 + 0.45 = 9 :thinking:"
        },
        "from": "5c4ddcd75dfafe51104f6521",
        "to": ["mwit25", "mwit26", "mwit27"]
      }
    }
  }
}

Announcement/Get

Get announcement by id

HTTP request

GET /api/v1/announce/get/:id

Request headers

Request header Description
Authorization JWT {JWT token}

Response

Returns a 200 HTTP status code and a JSON object with announcement data.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "announce data recived",
    "data": {
      "announce": {
        "id": "sxr409qi6bf7k78n9q1lll7h",
        "date": "2019-02-04T22:44:30.652Z",
        "message": {
          "title": "TPJR",
          "body": "8 + 0.45 = 9 :thinking:"
        },
        "from": "5c4ddcd75dfafe51104f6521",
        "to": ["mwit25", "mwit26", "mwit27"],
        "like": {
          "count": 20,
          "isLike": true
        }
      }
    }
  }
}

Announcement/List

List announcements by page (1 - Infinite)

HTTP request

GET /api/v1/announce/list/:page

Request headers

Request header Description
Authorization JWT {JWT token}

Response

Returns a 200 HTTP status code and a JSON object with announcement data.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "announces data recived",
    "data": {
      "announce": [
        {
          "id": "sxr409qi6bf7k78n9q1lll7h",
          "date": "2019-02-04T22:44:30.652Z",
          "message": {
            "title": "TPJR",
            "body": "8 + 0.45 = 9 :thinking:"
          },
          "from": "5c4ddcd75dfafe51104f6521",
          "to": ["mwit25", "mwit26", "mwit27"],
          "like": {
            "count": 20,
            "isLike": true
          }
        }
      ],...
    }
  }
}

Announcement/Remove

Remove announcements by id

HTTP request

DELETE /api/v1/announce/remove/:id

Request headers

Request header Description
Authorization JWT {Administrator JWT token}

Response

Returns a 200 HTTP status code and a JSON object.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "announce sucessfully deleted"
  }
}

Group

TBA

User

User/Profile

Retrive user profile

HTTP request

GET /api/v1/user/profile/:id/:type

Request headers

Request header Description
Authorization JWT {JWT token}

Path parameters

Parameter Description
type Types of data (Available: full, min)
id User ID

Response

Returns a 200 HTTP status code and a JSON object.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "user data recived",
    "data": {
      "user": {
        "id": "5c5afd3c04c0a657148ebe15",
        "authentication": {
          "user": "rayriffy",
          "role": "administrator"
        },
        "activation": {
          "isActivated": true,
          "ref": "30st2lkt"
        },
        "profile": {
          "fullname": "Riffy",
          "school": {
            "generation": 0,
            "room": 0
          }
        }
      }
    }
  }
}

User/Update

Update user profile

HTTP request

PUT /api/v1/user/update

Request headers

Request header Description
Content-Type application/json
Authorization JWT {JWT token}

Request body

Property Type Required Description
profile.fullname String Updated fullname
profile.school.generation Number Updated school generation
profile.school.room Number Updated room number
profile.notification.id String Updated push notification token
profile.notification.id.group String Updated notification group

Response

Returns a 200 HTTP status code and a JSON object.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "user updated",
  },
}

Push Notifications

Push/Send

Manually send push notification to topic user

HTTP request

POST /api/v1/push/send

Request headers

Request header Description
Content-Type application/json
Authorization JWT {Administrator JWT token}

Request body

Property Type Required Description
to String Required Topic users you wish to send
title String Required Notification title
text String Required Notification body

Response

Returns a 200 HTTP status code and a JSON object with empty data.

JSON 
{
  "status": "success",
  "code": 202,
  "response": {
    "message": "sending push notification to mwit25",
  }
}

Like

Like/Add

Add like to requested id

HTTP request

POST /api/v1/like/:type/add/:id

Request headers

Request header Description
Authorization JWT {JWT token}

Path parameters

Parameter Description
type Types of data (Available: announce)
id ID of that type

Response

Returns a 200 HTTP status code and a JSON object.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "you liked this announce"
  }
}

Like/Remove

Remove like from requested id

HTTP request

DELETE /api/v1/like/:type/remove/:id

Request headers

Request header Description
Authorization JWT {JWT token}

Path parameters

Parameter Description
type Types of data (Available: announce)
id ID of that type

Response

Returns a 200 HTTP status code and a JSON object.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "you unliked this announce"
  }
}

Like/Count

Count like from requested id

HTTP request

GET /api/v1/like/:type/count/:id

Request headers

Request header Description
Authorization JWT {JWT token}

Path parameters

Parameter Description
type Types of data (Available: announce)
id ID of that type

Response

Returns a 200 HTTP status code and a JSON object.

Property Type Description
response.data.count String Reference code for user activation
JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "counted this announce",
    "data": {
      "count": 20
    }
  }
}

Like/IsLike

Check that is user like this requested id or not

HTTP request

GET /api/v1/like/:type/islike/:id

Request headers

Request header Description
Authorization JWT {JWT token}

Path parameters

Parameter Description
type Types of data (Available: announce)
id ID of that type

Response

Returns a 200 HTTP status code and a JSON object.

JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "here is the result",
    "data": {
      "id": "5c71634482b93779c4fa7728",
      "isLike": true
    }
  }
}

Find

Find/Regex

Find data title and body by using RegExp

HTTP request

POST /api/v1/find/:type/regex

Path parameters

Parameter Description
type Types of data (Available: announce)

Request headers

Request header Description
Content-Type application/json

Request body

Property Type Required Description
regex String Required RegExp object

Response

Returns a 200 HTTP status code and a JSON object with the following data.

Property Type Description
response.data.announces Array Array of data object
JSON 
{
  "status": "success",
  "code": 201,
  "response": {
    "message": "announces data recived",
    "data": {
      "announces": [
        {
          "id": "sxr409qi6bf7k78n9q1lll7h",
          "date": "2019-02-04T22:44:30.652Z",
          "message": {
            "title": "TPJR",
            "body": "8 + 0.45 = 9 :thinking:"
          },
          "from": "5c4ddcd75dfafe51104f6521",
          "to": ["mwit25", "mwit26", "mwit27"],
          "like": {
            "count": 20,
            "isLike": true
          }
        },...
      ]
    }
  }
}

Notification

Notification/Create

Create notification group

HTTP request

POST /api/v1/noti/create

Request headers

Request header Description
Content-Type application/json
Authorization JWT {JWT token}

Request body

Property Type Required Description
name String Required Notification group name

Response

Returns a 200 HTTP status code and a JSON object with the following data.

Property Type Description
response.data.id String Notification group ID
response.data.name String Notification name

Notification/Get

Get list of subscribers token

HTTP request

GET /api/v1/noti/get/:id

Request headers

Request header Description
Authorization JWT {JWT token}

Path parameters

Parameter Description
id Notification group ID

Response

Returns a 200 HTTP status code and a JSON object.

Notification/List

List all existing notification group alphabetically

HTTP request

GET /api/v1/noti/list

Request headers

Request header Description
Authorization JWT {JWT token}

Response

Returns a 200 HTTP status code and a JSON object.

Notification/Remove

Remove notification group and related subscribers

HTTP request

DELETE /api/v1/noti/remove

Request headers

Request header Description
Content-Type application/json
Authorization JWT {JWT token}

Request body

Property Type Required Description
group String Required Notification group ID

Response

Returns a 200 HTTP status code and a JSON object.

Notification/Subscribe

Add expo token into notification group

HTTP request

POST /api/v1/noti/subscribe

Request headers

Request header Description
Content-Type application/json
Authorization JWT {JWT token}

Request body

Property Type Required Description
group String Required Notification group ID
token String Required Expo token

Response

Returns a 200 HTTP status code and a JSON object.

Notification/Unscribe

Remove expo token into notification group

HTTP request

DELETE /api/v1/noti/unsubscribe

Request headers

Request header Description
Content-Type application/json
Authorization JWT {JWT token}

Request body

Property Type Required Description
group String Required Notification group ID
token String Required Expo token

Response

Returns a 200 HTTP status code and a JSON object.