Portofolio API (1.0.0)

Download OpenAPI specification:Download

This is an Api documentation from website https://ontheklik.my.id to create landing page of anyone portofolio.

Introduction

This is the api documentation that I created for the first time

Auth

API For Login Users.

Login

header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: application/json
email
required
string <email>
password
required
string <password> >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "email": "ilhamsidik@gmail.com",
  • "password": "abcd1234"
}

Response samples

Content type
application/json
{
  • "message": "Login successful",
  • "token": "2|8wP3pQoArU5rMMBlWqbonW2fNRinhbMrXj2GUMU7373fb8c9"
}

Company

API For CRUD Company.

Get Self Company

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{}

Get Shift

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "shift_1": "08:00"
}

Users

API Manage Users.

Get Self Information

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{}

Update User Name

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "ilham sidik s"
}

Response samples

Content type
application/json
{
  • "message": "User update successfully."
}

Update User Photo

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: multipart/form-data
required
photo
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "message": "User update successfully."
}

Update User Password

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: application/json
required
old_password
required
string
new_password
required
string
new_password_confirmation
required
string

Responses

Request samples

Content type
application/json
{
  • "old_password": "OldPassword",
  • "new_password": "NewPassword",
  • "new_password_confirmation": "NewPassword"
}

Response samples

Content type
application/json
{
  • "message": "User update successfully."
}

Attendances

API For CRUD Attendences Users.

Get Attendance Today

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: application/json
required
date
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "date": "01-01-2024"
}

Response samples

Content type
application/json
{
  • "date": "01-01-2024",
  • "come": "08:10",
  • "home": "16:10",
  • "lateness": 10,
  • "num_of_working": 8
}

Get Statistic Attendance

Authorizations:
bearerAuth
path Parameters
month
required
string
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: application/json
required
date
required
string <date>

Responses

Request samples

Content type
application/json
{
  • "date": "2024-01-01"
}

Response samples

Content type
application/json
{
  • "num_of_work": 28,
  • "num_of_absence": 2,
  • "num_hours_work": 244,
  • "num_lateness": 30
}

Get Details Attendance

Authorizations:
bearerAuth
path Parameters
month
required
string
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "overview": {
    },
  • "details": [
    ]
}

Create Come Attendance

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: application/json
date
required
string <date>
shift
required
string
time
required
string <time>
longitude
required
number
latitude
required
number

Responses

Request samples

Content type
application/json
{
  • "date": "01-01-2024",
  • "shift": "shift_1",
  • "time": "08:10:20",
  • "longitude": 104.029834,
  • "latitude": -9.29327594
}

Response samples

Content type
application/json
{
  • "message": "Absence successful at 08:10:20"
}

Create Home Attendance

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: multipart/form-data
date
required
string <date>
time
required
string <time>
longitude
required
number
latitude
required
number
photo
required
string <binary>

Responses

Request samples

Content type
multipart/form-data
{
  "date": "01-01-2024",
  "time": "16:10:20",
  "longitude": 104.029834,
  "latitude": -9.29327594,
  "photo": "Binary Data"
}

Response samples

Content type
application/json
{
  • "message": "Absence successful at 16:10:20"
}

Create Absence Attendance

Authorizations:
bearerAuth
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: multipart/form-data
absence
required
string
date
required
string <date>
time
required
string <time (H:i)>
shift
required
string
longitude
required
number
latitude
required
number
photo
required
string <binary>

Responses

Request samples

Content type
multipart/form-data
{
  "absence": "sick",
  "date": "01-01-2024",
  "time": "08:00",
  "shift": "shift_1",
  "longitude": 104.029834,
  "latitude": -9.29327594,
  "photo": "Binary Data"
}

Response samples

Content type
application/json
{
  • "message": "Absence successful at 16:10:20"
}

IoT

API For RFID Attendances.

Create Attendances from IoT

path Parameters
rfid
required
string
Example: JZsVCk9q7tCQ6vtGXGFnsFNNlOM7vjba
header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: application/json
date
required
string <date>
time
required
string <time>

Responses

Request samples

Content type
application/json
{
  • "date": "01-01-2024",
  • "longitude": "08.00"
}

Response samples

Content type
application/json
{
  • "message": "Success"
}

IoT Register

header Parameters
API-Key
required
string
Example: your-api-key
Accept
required
string
Value: "application/json"
Request Body schema: application/json
rfid
required
string <uid>

Responses

Request samples

Content type
application/json
{
  • "rfid": "a3-121-s283-wj3yi-22"
}

Response samples

Content type
application/json
{
  • "message": "RFID Registered"
}