UD Rio Backend

Backend service for UD Rio (prototype) website.

• ERD: https://dbdiagram.io/d/6269412a95e7f23c6182e685

Get Started

---

You need to have docker-compose to simplify development, config your .env and edit Dockerfile if you wish to use hot reload and run the following command to setup your local db & run dev server

docker-compose up -d

To stop dev server simply run

docker-compose down
# or
docker-compose stop

Authentication (OAuth2)

---

--- Sign In ---

• Method: GET

• Endpoint: /oauth/login/google

• Header:

  • Content-Type: text/html

• Response:

  • redirect -> <FE_URL>?access_token=<access_token>&expires_in=<expires_in>&refresh_token=<refresh_token>

• Error Response:

  • redirect -> <FE_URL>?err=<err_msg>

--- Refresh Access Token ---

• Method: POST

• Endpoint: /oauth/refresh/

• Header:

  • Content-Type: application/json
  • Authorization: Bearer <refresh_token>

• Response:

{
  "code": 200,
  "status": "OK",
  "error": null,
  "data": {
    "access_token": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
    "expires_in": 1676801048,
    "refresh_token": "IwOGYzYTlmM2YxOTQ5MGE3YmNmMDFkNTVk"
  }
}

• Error Response

{
  "code": 400,
  "status": "BAD_REQUEST",
  "error": {
    "message": "invalid refresh token header"
  },
  "data": null
}

User

---

--- User Profile ---

• Method: GET

• Endpoint: /api/users/

• Header:

  • Content-Type: application/json
  • Authorization: Bearer <access_token>

• Response:

{
  "code": 200,
  "status": "OK",
  "error": null,
  "data": {
    "id": "712398192038190",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john@mail.com",
    "picture": "https://google.com/picture.png",
    "locale": "id"
  }
}

• Error Response

{
  "code": 403,
  "status": "UNAUTHORIZED",
  "error": {
    "message": "no access token"
  },
  "data": null
}

Products

---

--- List of categories ---

• Method: GET

• Endpoint: /api/categories/

• Header:

  • Content-Type: application/json

• Response:

{
  "code": 200,
  "status": "OK",
  "error": null,
  "data": [
    {
      "id": 1,
      "category": "Spanduk & Banner",
      "icon": "https://domain.com/ico.png"
    },
    {
      "id": 2,
      "category": "Cetak Kalender & Kartu Nama",
      "icon": "https://domain.com/ico.png"
    },
    {
      "id": 3,
      "category": "Undangan, Karcis/Tiket & Foto",
      "icon": "https://domain.com/ico.png"
    },
    {
      "id": 4,
      "category": "Perkantoran",
      "icon": "https://domain.com/ico.png"
    }
  ]
}

• Error Response

{
  "code": 404,
  "status": "NOT_FOUND",
  "error": {
    "message": "categories empty"
  },
  "data": null
}

--- List of products ---

• Method: GET

• Endpoint: /api/products/

• Params:

  • size: 20 (default/optional)
  • page: 1 (default/optional)
  • category_id: 1 (optional)
  • query: Kertas%20HVS (optional)

• Header:

  • Content-Type: application/json

• Response:

{
  "code": 200,
  "status": "OK",
  "error": null,
  "data": [
    {
      "id": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
      "product_name": "Kop Surat",
      "product_category": {
        "category_id": 1,
        "category": "ATK",
        "icon": "https://domain.com/image.png"
      },
      "price": 7500,
      "is_available": true,
      "images": [
        {
          "image_id": "jkl",
          "url": "product_image"
        },
        {
          "image_id": "ijkl",
          "url": "image2"
        }
      ],
      "description": "Menggunakan kertas  NCR, ukuran 1/8 Folio 1 blok 1 Ply isi 100 lbr, 1 blok 2-4 Ply isi 50 set, Urutan warna pertama selalu putih",
      "min_order": 24,
      "created_at": "2023-01-18T12:03:56.595459Z",
      "updated_at": "2023-01-18T12:03:56.595459Z"
    },
    {
      "id": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI6",
      "product_name": "Nama Dada / Namepin Gravir Hitam Standar Uk. 2x8cm",
      "product_category": {
        "category_id": 2,
        "category": "Aksesoris",
        "icon": "https://domain.com/image.png"
      },
      "price": 30000,
      "is_available": false,
      "images": [
        {
          "image_id": "jkl",
          "url": "product_image"
        },
        {
          "image_id": "ijkl",
          "url": "image2"
        }
      ],
      "description": "Nama dada berbahan PVC Warna Hitam digravir dengan mesin Laser Uk. 2x8 cm pakai Peniti. Bisa juga pakai magnet atau paku",
      "min_order": 1,
      "created_at": "2023-01-18T12:03:56.595459Z",
      "updated_at": "2023-01-18T12:03:56.595459Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "total_page": 10,
    "total_data": 200,
    "next_page": 2,
    "previous_page": 1
  }
}

• Error Response

{
  "code": 400,
  "status": "BAD_REQUEST",
  "error": {
    "message": "invalid param",
    "category": "invaild category"
  },
  "data": null
}

--- Product Detail ---

• Method: GET

• Endpoint: /api/products/{product_id}

• Header:

  • Content-Type: application/json

• Response:

{
  "code": 200,
  "status": "OK",
  "error": null,
  "data": {
    "id": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
    "product_name": "Kop Surat",
    "product_category": {
      "category_id": 1,
      "category": "ATK",
      "icon": "https://domain.com/image.png"
    },
    "price": 7500,
    "is_available": true,
    "images": [
      {
        "image_id": "jkl",
        "url": "product_image"
      },
      {
        "image_id": "ijkl",
        "url": "image2"
      }
    ],
    "description": "Menggunakan kertas  NCR, ukuran 1/8 Folio 1 blok 1 Ply isi 100 lbr, 1 blok 2-4 Ply isi 50 set, Urutan warna pertama selalu putih",
    "min_order": 24,
    "created_at": "2023-01-18T12:03:56.595459Z",
    "updated_at": "2023-01-18T12:03:56.595459Z"
  }
}

• Error Response

{
  "code": 400,
  "status": "BAD_REQUEST",
  "error": {
    "message": "record not found"
  },
  "data": null
}

Cart

---

--- Get User Cart ---

• Method: GET

• Endpoint: /api/carts/

• Header:

  • Content-Type: application/json
  • Authorization: Bearer <access_token>

• Response:

{
  "code": 200,
  "status": "OK",
  "error": null,
  "data": [
    {
      "quantity": 2,
      "product_id": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
      "product_name": "Kop Surat",
      "price": 7500,
      "is_available": true,
      "image": "http://product_image.png",
      "min_order": 24
    },
    {
      "quantity": 2,
      "product_id": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
      "product_name": "Kop Surat",
      "price": 7500,
      "is_available": true,
      "image": "http://product_image.png",
      "min_order": 24
    }
  ]
}

• Error Response

{
  "code": 403,
  "status": "UNAUTHORIZED",
  "error": {
    "message": "no access token"
  },
  "data": null
}

--- Put User Cart ---

• Method: PUT

• Endpoint: /api/carts/

• Header:

  • Content-Type: application/json
  • Authorization: Bearer <access_token>

• Body:

{
  "product_id": "askdjaskd",
  "quantity": 2
}

• Response:

{
  "code": 201,
  "status": "OK",
  "error": null,
  "data": null
}

• Error Response

{
  "code": 403,
  "status": "UNAUTHORIZED",
  "error": {
    "message": "no access token"
  },
  "data": null
}

Order

---

--- Get User Orders ---

• Method: GET

• Endpoint: /api/orders/

• Header:

  • Content-Type: application/json
  • Authorization: Bearer <access_token>

• Response:

{
  "code": 200,
  "status": "OK",
  "error": null,
  "data": [
    {
      "order_id": "asbdjkashdkalsd",
      "sub_total": 15000,
      "items": [
        {
          "product_id": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
          "product_name": "Kop Surat",
          "quantity": 2,
          "price": 4000,
          "total_price": 8000,
          "image": "http://product_image.png"
        },
        {
          "product_id": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
          "product_name": "Kop Surat",
          "price": 4000,
          "total_price": 8000,
          "image": "http://product_image.png"
        }
      ]
    }
  ]
}

• Error Response

{
  "code": 403,
  "status": "UNAUTHORIZED",
  "error": {
    "message": "no access token"
  },
  "data": null
}

--- Post Order ---

• Method: POST

• Endpoint: /api/orders/

• Header:

  • Content-Type: application/json
  • Authorization: Bearer <access_token>

• Body:

{
  "orders": [
    {
      "product_id": "A001ABC",
      "quantity": 2
    },
    {
      "product_id": "A001ABC",
      "quantity": 2
    }
  ]
}

• Response:

{
  "code": 201,
  "status": "OK",
  "error": null,
  "data": null
}

• Error Response

{
  "code": 403,
  "status": "UNAUTHORIZED",
  "error": {
    "message": "no access token"
  },
  "data": null
}