pembukuan_tk API

PembukuanTK is an API for managing your store. Through this API, we hope that small business will grow in a positive trajectory. This is so cool, isn't it?

Architecture

We are different, not using MVC anymore. Using this Clean Arch by Uncle Bob Martin, we have a chance to create multiple data source and multiple delivery. Right now, we provide blazing fast DB SQLITE and delivered by JSON. Also, by using GO + MUX Router Helper + JSON Web Token, we can create secure endpoints without excuses. Anyway, Thx to bxcodec has explained this examples.

How to Run

Simply run this command

go run main.go

Want to see our deployment on server? go check out this link
Upss 😱, want to see more? come and send us by issues

Meet the actors

1. User
2. Admin 
3. Customer

Tech Stack

1. Heroku
2. Golang REST API 
3. DB SQLite
4. GO MUX Router Helper 
5. JSON Web Token for securing Endpoints

API without JWT Token

POST -> /login
header : null
payload :
{
	"username": "jo",
	"password": "jo"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "username": "jo",
    "user_type_id": 2,
    "user_id": 1,
    "token": "auth token goes here"
  }
}

Token Checking

POST -> /token/expired
header : null
payload :
{
	"token" : "input your auth token here"
}
response : 
{
  "status": "success",
  "message": "token is valid",
  "data": null
}

API USER with JWT Token

Get All Products

GET -> /products
header : user token
payload : null
response : 
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 1,
      "name": "kopi janji jiwa",
      "price": "1000",
      "stock": 99
    }
  ]
}

Get All Customers

GET -> /customers
header : user token
payload : null
response : 
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 1,
      "name": "randi julon",
      "phone": "082208220822",
      "email": "randi@gmail.com",
      "address": "malang"
    }
  ]
}

Get All Invoices

GET -> /invoice
header : user token
payload : null
response : 
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 1,
      "customer_name": "randi julon",
      "customer_phone": "082208220822",
      "customer_email": "randi@gmail.com",
      "customer_address": "malang",
      "total_invoice_price": "1000",
      "created_at": "1607178612",
      "updated_at": "1607178612",
      "products": [
        {
          "product_name": "kopi janji jiwa",
          "product_qty": "1",
          "product_price": "1000",
          "product_total_price": "1000"
        }
      ]
    }
  ]
}

Get Invoice Detail By ID

POST -> /invoice/detail
header : user token
payload : 
{
	"invoice_id": 1
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "customer_name": "randi julon",
    "customer_phone": "082208220822",
    "customer_email": "randi@gmail.com",
    "customer_address": "malang",
    "total_invoice_price": "1000",
    "created_at": "1607178612",
    "updated_at": "1607178612",
    "products": [
      {
        "product_name": "kopi janji jiwa",
        "product_qty": "1",
        "product_price": "1000",
        "product_total_price": "1000"
      }
    ]
  }
}

Get Statistics By Year

POST -> /statistics
header : user token
payload : 
{
	"year": "2019"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "year": "2020",
    "detail": [
      {
        "mon": "january",
        "profit": 0
      },
      {
        "mon": "february",
        "profit": 0
      },
      {
        "mon": "march",
        "profit": 0
      },
      {
        "mon": "april",
        "profit": 0
      },
      {
        "mon": "may",
        "profit": 0
      },
      {
        "mon": "june",
        "profit": 0
      },
      {
        "mon": "july",
        "profit": 0
      },
      {
        "mon": "august",
        "profit": 0
      },
      {
        "mon": "september",
        "profit": 0
      },
      {
        "mon": "october",
        "profit": 0
      },
      {
        "mon": "november",
        "profit": 0
      },
      {
        "mon": "december",
        "profit": 70000
      }
    ]
  }
}

Input New Invoice With Products

POST -> /invoice
header : user token
payload : 
{
	"customer_id": 1,
	"user_id": 1,
	"list_product": [
		{
			"product_id": 1,
			"qty": 1
		}
	]
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "customer_id": 1,
    "user_id": 1
  }
}

Input New Stock for Product

POST -> /products/stock
header : user token
payload : 
{
	"product_id" : 1,
	"quantity" : 100,
	"user_id" : 1
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "product_id": 1,
    "quantity": 100,
    "user_id": 1
  }
}

Input New Product

POST -> /products
header : user token
payload : 
{
	"name": "kopi janji jiwa",
	"price": "1000"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "name": "kopi janji jiwa",
    "price": "1000"
  }
}

Input New Customer

POST -> /customers
header : user token
payload : 
{
	"name": "randi julon",
	"phone": "082208220822",
	"email": "randi@gmail.com",
	"address": "malang"
}
response : 
{
  "status": "success",
  "message": "inserted successfully",
  "data": {
    "id": 1,
    "name": "randi julon",
    "phone": "082208220822",
    "email": "randi@gmail.com",
    "address": "malang"
  }
}

Edit Customer By ID

PUT -> /customers
header : user token
payload : 
{
	"name": "randi edit haha",
	"phone": "082208220822",
	"email": "randi@gmail.com",
	"address": "malang",
	"id": 1
}
response : 
{
  "status": "success",
  "message": "inserted successfully",
  "data": {
    "id": 1,
    "name": "randi edit haha",
    "phone": "082208220822",
    "email": "randi@gmail.com",
    "address": "malang"
  }
}

Edit Product By ID

PUT -> /products
header : user token
payload : 
{
	"id": 1,
	"name": "kopi excelso",
	"price": "500000"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "name": "kopi excelso",
    "price": "500000"
  }
}

Delete Product

POST -> /products/delete
header : user token
payload : 
{
	"id": 2
}
response :
{
  "status": "success",
  "message": "user deleted successfully",
  "data": null
}

Delete Customer

POST -> /customers/delete
header : user token
payload : 
{
	"id": 2
}
response :
{
  "status": "success",
  "message": "customer deleted successfully",
  "data": null
}

API ADMIN with JWT Token

Get All Products

GET -> /admin/products
header : admin token
payload : null
response : 
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 1,
      "name": "kopi janji jiwa",
      "price": "1000",
      "stock": 99
    }
  ]
}

Get All Customers

GET -> /admin/customers
header : admin token
payload : null
response : 
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 1,
      "name": "randi julon",
      "phone": "082208220822",
      "email": "randi@gmail.com",
      "address": "malang"
    }
  ]
}

Get All Invoices

GET -> /admin/invoice
header : admin token
payload : null
response : 
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 1,
      "customer_name": "randi julon",
      "customer_phone": "082208220822",
      "customer_email": "randi@gmail.com",
      "customer_address": "malang",
      "total_invoice_price": "1000",
      "created_at": "1607178612",
      "updated_at": "1607178612",
      "products": [
        {
          "product_name": "kopi janji jiwa",
          "product_qty": "1",
          "product_price": "1000",
          "product_total_price": "1000"
        }
      ]
    }
  ]
}

Get Invoice Detail By ID

POST -> /admin/invoice/detail
header : admin token
payload : 
{
	"invoice_id": 1
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "customer_name": "randi julon",
    "customer_phone": "082208220822",
    "customer_email": "randi@gmail.com",
    "customer_address": "malang",
    "total_invoice_price": "1000",
    "created_at": "1607178612",
    "updated_at": "1607178612",
    "products": [
      {
        "product_name": "kopi janji jiwa",
        "product_qty": "1",
        "product_price": "1000",
        "product_total_price": "1000"
      }
    ]
  }
}

Get Statistics By Year

POST -> /admin/statistics
header : admin token
payload : 
{
	"year": "2020"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "year": "2020",
    "detail": [
      {
        "mon": "january",
        "profit": 0
      },
      {
        "mon": "february",
        "profit": 0
      },
      {
        "mon": "march",
        "profit": 0
      },
      {
        "mon": "april",
        "profit": 0
      },
      {
        "mon": "may",
        "profit": 0
      },
      {
        "mon": "june",
        "profit": 0
      },
      {
        "mon": "july",
        "profit": 0
      },
      {
        "mon": "august",
        "profit": 0
      },
      {
        "mon": "september",
        "profit": 0
      },
      {
        "mon": "october",
        "profit": 0
      },
      {
        "mon": "november",
        "profit": 0
      },
      {
        "mon": "december",
        "profit": 70000
      }
    ]
  }
}

Input New Invoice With Products

POST -> /admin/invoice
header : admin token
payload : 
{
	"customer_id": 1,
	"user_id": 1,
	"list_product": [
		{
			"product_id": 1,
			"qty": 1
		}
	]
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "customer_id": 1,
    "user_id": 1
  }
}

Input New Stock for Product

POST -> /admin/products/stock
header : admin token
payload : 
{
	"product_id" : 1,
	"quantity" : 100,
	"user_id" : 1
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "product_id": 1,
    "quantity": 100,
    "user_id": 1
  }
}

Input New Product

POST -> /admin/products
header : admin token
payload : 
{
	"name": "kopi janji jiwa",
	"price": "1000"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "name": "kopi janji jiwa",
    "price": "1000"
  }
}

Input New Customer

POST -> /admin/customers
header : admin token
payload : 
{
	"name": "randi julon",
	"phone": "082208220822",
	"email": "randi@gmail.com",
	"address": "malang"
}
response : 
{
  "status": "success",
  "message": "inserted successfully",
  "data": {
    "id": 1,
    "name": "randi julon",
    "phone": "082208220822",
    "email": "randi@gmail.com",
    "address": "malang"
  }
}

Edit Customer By ID

PUT -> /admin/customers
header : admin token
payload : 
{
	"name": "randi edit haha",
	"phone": "082208220822",
	"email": "randi@gmail.com",
	"address": "malang",
	"id": 1
}
response : 
{
  "status": "success",
  "message": "inserted successfully",
  "data": {
    "id": 1,
    "name": "randi edit haha",
    "phone": "082208220822",
    "email": "randi@gmail.com",
    "address": "malang"
  }
}

Edit Product By ID

PUT -> /admin/products
header : admin token
payload : 
{
	"id": 1,
	"name": "kopi excelso",
	"price": "500000"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 1,
    "name": "kopi excelso",
    "price": "500000"
  }
}

Get All Users

GET -> /admin/users
header : admin token
payload : null
response : 
{
  "status": "success",
  "message": "",
  "data": [
    {
      "id": 1,
      "username": "jo",
      "password": "password encrypted"
      "user_type_id": 2
    },
    {
      "id": 3,
      "username": "huhu",
      "password": "password encrypted"
      "user_type_id": 2
    }
  ]
}

Input New User

POST -> /admin/users
header : admin token
payload : 
{
	"username" : "har",
	"password" : "har"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 3,
    "username": "har",
    "password": "password encrpyted"
    "user_type_id": 2
  }
}

Edit User By ID

PUT -> /admin/users
header : admin token
payload : 
{
	"id": 3,
	"username": "huhu",
	"password": "huhu"
}
response : 
{
  "status": "success",
  "message": "",
  "data": {
    "id": 3,
    "username": "huhu",
    "password": "password encrypted"
    "user_type_id": 2
  }
}

Delete Product

POST -> /admin/products/delete
header : user token
payload : 
{
	"id": 1
}
response :
{
  "status": "success",
  "message": "product deleted successfully",
  "data": null
}

Delete Customer

POST -> /admin/customers/delete
header : user token
payload : 
{
	"id": 1
}
response :
{
  "status": "success",
  "message": "customer deleted successfully",
  "data": null
}

Delete User

POST -> /admin/users/delete
header : user token
payload : 
{
	"id": 1
}
response :
{
  "status": "success",
  "message": "user deleted successfully",
  "data": null
}

huf0813/pembukuan_tk