Rest API

[mgilangjanuar]

Hello guys!

I just made the public workspace in Postman to test the API, here's the wiki.

The common error response will throw object like this

{
  error: string,
  details?: object | string
}

I'll update the endpoints that are ready to use in this thread 🍻

[mgilangjanuar]

• Auth
  • sendCode
  • reSendCode
  • login
  • me
• Users
  • me
  • find
  • retrieve
• Files
  • sync
  • download
  • upload
  • cancel

[mgilangjanuar]

Here's the demo for using the auth endpoints

Screen.Recording.2021-08-29.at.10.48.18.mov

Feel free to ask me anytime 👌

[mgilangjanuar]

Filters

[GET] /api/v1/resources?foo=bar

If you want to use another operator to filter the resources (by default eq), you can do like this:

[GET] /api/v1/resources?name.like=%gilang%
[GET] /api/v1/resources?created_at.lte=2021-08-29T08:37:21.448Z
[GET] /api/v1/resources?created_at.gt=2021-08-29T06:37:21.448Z

The available operators:

type FilterOperator =
  | 'eq'
  | 'neq'
  | 'gt'
  | 'gte'
  | 'lt'
  | 'lte'
  | 'like'
  | 'ilike'
  | 'is'
  | 'in'
  | 'cs'
  | 'cd'
  | 'sl'
  | 'sr'
  | 'nxl'
  | 'nxr'
  | 'adj'
  | 'ov'
  | 'fts'
  | 'plfts'
  | 'phfts'
  | 'wfts'

Pagination

[GET] /api/v1/resources?page=0&size=10

Param page is zero-based.

Sort

[GET] /api/v1/resources?sort=created_at:desc,name:asc