How to use API to get the records from the CrossChex Cloud?

Inorder to get the employee’s records from the CrossChex Cloud. Anviz not only provide the webhooks function to push the time attendance data to your server, (CrossChex Cloud Webhooks) now we provide the API to get the records from the CrossChex Cloud Server.

The CrossChex Cloud API URL: https://api.ap.crosschexcloud.com/

Get Token Request:

Name Value Type Necessary Description
header[nameSpace] authorize.token Text Yes Fixed Value
header[nameAction] token Text Yes Fixed Value
header[version] 1.0 Text Yes Fixed Value
header[requestId] f1becc28-ad01-b5b2-7cef-392eb1526f39 Text Yes Request ID (Unique)
header[timestamp] 2022-10-21T07:39:07+00:00 Text Yes Timestamp
payload[api_key] Follow with CrossChex Cloud Account Text Yes Api Key
payload[api_secret] Follow with CrossChex Cloud Account Text Yes Api Secret

Respond Parameter Instruction:(200) Success

Name Value Type Description
code 200 Number Success.
data Object Repond Data
data.payload Object
data.payload.token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wYW55X2NvZGUiOiIxMTAwMDA4MzEiLCJob29rc19vbiI6MCwidXJsIjoiIiwic2VjcmV0IjoiIiwiY3JlYXRlX3RpbWUiOiIyMDIyLTEwLTE4IDA3OjQwOjE4IiwidXBkYXRlX3RpbWUiOiIiLCJhcGlfa2V5IjoiYTQ4ZjRkNGFiNWM2ZDAwMjk2NDMxZTRhZGRmZWMzNzUiLCJhcGlfc2VjcmV0IjoiNmViMmE0N2EyMmU2MDYyN2QzZjE0OGI0NDEzOGVlZGEiLCJleHAiOjE2NjY1OTcxNDd9.4jelxAUXaxjcxisIxAUkw3Bp9ljhQBFLw9O_6BgH6kw String Authentication Token
data.payload.expires 2022-10-24T07:39:07+00:00 String Expiration Time
data.header Object
data.header.nameSpace authorize.token String
data.header.nameAction token String
data.header.version 1.0 String
data.header.requestId Object
data.header.timestamp Object
description Object
error {} Object Respond Error

POST Get Record

Name Value Type Necessary Description
header[nameSpace] attendance.record Text Yes Fixed Value
header[nameAction] getrecord Text Yes Fixed Value
header[version] 1.0 Text Yes Fixed Value
header[requestId] f1becc28-ad01-b5b3-7cef-392eb1526f39 Text Yes Request ID (Unique)
header[timestamp] 2022-10-23T07:39:07+00:00 Text Yes Timestamp
authorize[type] token Text Yes Fixed Value
authorize[token] eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wYW55X2NvZGUiOiIxMTAwMDA4MzEiLCJob29rc19vbiI6MCwidXJsIjoiIiwic2VjcmV0IjoiIiwiY3JlYXRlX3RpbWUiOiIyMDIyLTEwLTE4IDA3OjQwOjE4IiwidXBkYXRlX3RpbWUiOiIiLCJhcGlfa2V5IjoiYTQ4ZjRkNGFiNWM2ZDAwMjk2NDMxZTRhZGRmZWMzNzUiLCJhcGlfc2VjcmV0IjoiNmViMmE0N2EyMmU2MDYyN2QzZjE0OGI0NDEzOGVlZGEiLCJleHAiOjE2NjY1OTcxNDd9.4jelxAUXaxjcxisIxAUkw3Bp9ljhQBFLw9O_6BgH6kw Text Yes get token respond value
payload[begin_time] 2022-06-01T12:46:43+00:00 Text Yes Get Record Start time
payload[end_time] 2022-10-24T12:46:43+00:00 Text Yes Get Record End time
payload[workno] 1 Text No Employee ID
payload[order] asc Text No Sequence,Default is asc,from from small to large
payload[page] 1 Text Yes Paging data from 1st page
payload[per_page] 1 Text Yes Max with 1000 records each page

Respond Parameter Instruction :(200)Success

Name Value Type Description
code 200 Number Success
data Object Repond Data
data.payload Object
data.payload.count 148 Number Total of reocrds
data.payload.list Object
data.payload.list.checktype 128 Number
data.payload.list.checktime 2022-07-20T20:15:05+00:00 String
data.payload.list.device Object
data.payload.list.device.serial_number 1750120622290025 String
data.payload.list.device.name FaceDeep3-IRT10 String
data.payload.list.employee Object
data.payload.list.employee.first_name 1 String
data.payload.list.employee.last_name 1 String
data.payload.list.employee.workno 1 String
data.payload.page 1 Number Page Number
data.payload.perPage 1 Number Count of Records with each page
data.payload.pageCount 148 Number Total of Pages
data.header Object
data.header.nameSpace attendance.record String
data.header.nameAction getrecord String
data.header.version 1.0 String
data.header.requestId f1becc28-ad01-b5b3-7cef-392eb1526f39 String
data.header.timestamp 2022-10-23T07:39:07+00:00 String
description Object
error {} Object Respond Error

Please leave message here to active your CrossChex Cloud API.

2 Likes