Dokumentasyon ng API

Pagkonekta at Pagtatrabaho sa Shifton API

Ang Shifton API ay nagbibigay sa iyo ng access sa lahat ng pangunahing tampok ng platform — mula sa pamamahala ng iskedyul hanggang sa integrasyon sa mga panlabas na HR, payroll, at analytics systems.
Sa paggamit ng API, maaari mong i-automate ang mga proseso at ikonekta ang Shifton sa internal services ng iyong kumpanya.


Dokumentasyon ng API

Suportado namin ang dalawang bersyon ng aming dokumentasyon:


Pagsisimula

Kumuha ng API Key

Sa mga setting ng iyong kumpanya sa Shifton platform, bumuo ng isang API key.
Ang awtorisasyon ay ginagawa sa pamamagitan ng header:

Authorization: Bearer {your_api_key}

Gumawa ng Iyong Unang Request

Halimbawa, upang makuha ang listahan ng mga empleyado:

GET /api/v1/employees
Host: api2.shifton.com
Authorization: Bearer {your_api_key}

Halimbawang tugon:

{
"data": [
{
"id": 101,
"name": "Alice Johnson",
"position": "HR Manager"
},
{
"id": 102,
"name": "Bob Smith",
"position": "Cashier"
}
]
}

I-integrate ang API sa Iyong Workflows

  • Awtomatikong lumikha at i-modify ang mga shift

  • Pamahalaan ang mga kahilingan sa bakasyon at sick leave

  • I-export ang data sa mga payroll systems

  • Gumawa ng mga custom na dashboard at report


Pangunahin na API Kakayahan

  • Mga Empleyado – magdagdag, mag-edit, at pamahalaan ang mga tungkulin

  • Mga Iskedyul – lumikha, ayusin ang mga shift, planuhin ang trabaho

  • Oras ng Pahinga at Pagliban – pamahalaan ang mga kahilingan para sa bakasyon at pagliban dahil sa sakit

  • Ulat – i-export ang oras, payroll, at attendance data


Mga Error Code

Gumagamit ang Shifton API ng karaniwang mga HTTP status code:

  • 200 — Matagumpay na kahilingan

  • 201 — Matagumpay na nalikha ang bagay

  • 400 — Hindi wastong mga parameter

  • 401 — Error sa awtorisasyon (di-wastong API key)

  • 403 — Access tinanggihan

  • 404 — Hindi natagpuan ang mapagkukunan

  • 500 — Error sa server


Mga Tip sa Paggamit

  • Palaging gamitin ang bagong bersyon ng API para sa mga bagong pagsasama

  • Gamitin Postman o curl para sa pagsubok

  • Igalang ang mga limitasyon ng rate para maiwasang ma-block

  • I-update ang mga integrasyon na nakabase pa rin sa luma na dokumentasyon


Ibahagi ang post na ito