iButton list

This API retrieves a list of iButtons assigned to a vehicle for a specified period.
An iButton is a small electronic device (tag) used to identify drivers or objects. It is typically applied for access control, work time tracking, or recording the start/end of vehicle usage.

How to get data

Method

GET

Request address

To get the data, use the address: https://<server_address>/api/api.php?

Request parameters

  • cmd=take_ibutton_list — command for the API to get the iButton list
  • ts — start date of the period (Unix timestamp)
  • te — end date of the period (Unix timestamp)
  • agentId— vehicle identifier
  • node — node number where the command is executed
 

Example request

https://<server_address>/api/api.php?cmd=take_ibutton_list&ts=1643662800&te=1645045200&AgentID=79673&node=1
Response
{
    "code": 0,
    "msg": "OK",
    "data": [
        {
            "ibutton": "ae00001000000000",
            "ts": 1643680128
        },
        {
            "ibutton": "ae00001000000001",
            "ts": 1643680128
        }
    ]
}
In response to the API request, the following is returned:
  • code — result code (0 = success)
  • msg — server message (e.g., "OK")
  • data — array with information about iButtons:
  • ibutton — unique iButton identifier
  • ts— timestamp when the iButton was registered (Unix timestamp)