API reference
Kiosks
8 endpoints. Click one to see its parameters, fields and an example. Code samples use the region you pick.
GET/v1/kioskKiosk boot info (kiosk token required)
Kiosk boot info (kiosk token required)
Example
curl "https://ca-api.clocklap.com/v1/kiosk" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
GET/v1/kiosk/break-rulesThe clock-out questions this kiosk asks (kiosk token required)
The clock-out questions this kiosk asks (kiosk token required)
Example
curl "https://ca-api.clocklap.com/v1/kiosk/break-rules" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
POST/v1/kiosk/pairA tablet trades the short pairing code from the console for its kiosk token (15 minutes, once)
A tablet trades the short pairing code from the console for its kiosk token (15 minutes, once)
Body (JSON)
| Name | Type | Description |
|---|---|---|
coderequired | string |
Example
curl -X POST "https://ca-api.clocklap.com/v1/kiosk/pair" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"code":"string"}'Responses
200
POST/v1/kiosk/punchPunch at a shared kiosk with a PIN. type=auto toggles in/out; type=break starts or ends the break.
Punch at a shared kiosk with a PIN. type=auto toggles in/out; type=break starts or ends the break.
After 5 wrong PINs in a row the kiosk pauses for a few minutes (429 kiosk_locked).
Body (JSON)
| Name | Type | Description |
|---|---|---|
pinrequired | string | |
type | "auto" | "in" | "out" | "break_start" | "break_end" | "break" | Default "auto" |
local_idrequired | string | |
at | string (date-time) | |
photo_asset_id | string | |
device_now | string (date-time) | The device's current time when sending. When it differs from the server's by more than 2 minutes, punch times are corrected by that difference (and flagged for review beyond 10 minutes). |
project_id | string or null | |
activity_id | string or null |
Example
curl -X POST "https://ca-api.clocklap.com/v1/kiosk/punch" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"pin":"string","local_id":"loc_01J…"}'Responses
200
GET/v1/kiosksList kiosks
List kiosks
Query parameters
| Name | Type | Description |
|---|---|---|
location_id | string |
Example
curl "https://ca-api.clocklap.com/v1/kiosks" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
POST/v1/kiosksPair a shared tablet to a location. The token is shown once.
Pair a shared tablet to a location. The token is shown once.
Body (JSON)
| Name | Type | Description |
|---|---|---|
location_idrequired | string | |
namerequired | string |
Example
curl -X POST "https://ca-api.clocklap.com/v1/kiosks" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY" \
-H "Content-Type: application/json" \
-d '{"location_id":"loc_01J…","name":"Example"}'Responses
200
DELETE/v1/kiosks/{id}Delete one kiosk
Delete one kiosk
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Example
curl -X DELETE "https://ca-api.clocklap.com/v1/kiosks/{id}" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200
POST/v1/kiosks/{id}/pairing-codeA new 15-minute pairing code, to set up a replacement tablet. Once it is used, the current tablet is signed out.
A new 15-minute pairing code, to set up a replacement tablet. Once it is used, the current tablet is signed out.
Path parameters
| Name | Type | Description |
|---|---|---|
idrequired | string |
Example
curl -X POST "https://ca-api.clocklap.com/v1/kiosks/{id}/pairing-code" \
-H "Authorization: Bearer $CLOCKLAP_API_KEY"Responses
200