A device has the following attributes:
Name | Type | Description |
---|---|---|
id | Integer | Record ID |
serial_number | String | Equipment serial number |
enabled | Boolean | Determine whether the device can access CloudWalk (default true) |
logical_number_id | Integer | Logical Number ID associated with the device |
meta | JSON | Additional information such as brand, model, etc |
framework_version | String | Device CloudWalk Framework Version installed |
updated_at | String | Timestamp in ISO 8601 format |
created_at | String | Timestamp in ISO 8601 format |
created_by | Integer | User ID that created the record |
created_via | String | Channel used to create the record (Interface or API) |
Return an array with all devices.
GET https://api.cloudwalk.io/{version}/devices?access_token={token}
$ curl -X GET "https://api.cloudwalk.io/v1/devices?access_token=$TOKEN"
require 'net/http'
token = 'API_TOKEN'
uri = URI("https://api.cloudwalk.io/v1/devices?access_token=#{token}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
res = http.request(request)
puts "Response #{res.code} #{res.message}: #{res.body}"
{
"pagination":{
"page":1,
"total_pages":1,
"entries":2,
"total_entries":2
},
"devices":[
{
"device":{
"id":1,
"serial_number":"123-456-789",
"enabled":true,
"framework_version":"5.10.2",
"meta":{
"brand":"pax",
"model":"d200",
"communication_media":"gprs",
"gprs_signal":"80",
"sim_card_id":"8955101234567890",
"os_version":"2.4.104",
"emv_kernel_version":"v602_01 2015.04.02",
"ssa_version":"",
"battery_level":"50",
"ssl":"on",
"signature":"production"
},
"updated_at":"2015-01-30T17:42:41Z",
"created_at":"2015-01-30T17:42:41Z",
"created_by":1,
"created_via":"interface"
}
},
{
"device":{
"id":2,
"serial_number":"111-222-333",
"enabled":true,
"framework_version":"5.10.2",
"meta":{
"brand":"pax",
"model":"d200",
"communication_media":"gprs",
"gprs_signal":"80",
"sim_card_id":"8955101234567890",
"os_version":"2.4.104",
"emv_kernel_version":"v602_01 2015.04.02",
"ssa_version":"",
"battery_level":"50",
"ssl":"on",
"signature":"production"
},
"updated_at":"2015-01-30T17:47:40Z",
"created_at":"2015-01-30T17:47:40Z",
"created_by":1,
"created_via":"interface"
}
}
]
}
Return the details of a specific device.
GET https://api.cloudwalk.io/{version}/devices/{device_id}?access_token={token}
$ curl -X GET "https://api.cloudwalk.io/v1/devices/2?access_token=$TOKEN"
require 'net/http'
token = 'API_TOKEN'
uri = URI("https://api.cloudwalk.io/v1/devices/2?access_token=#{token}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
res = http.request(request)
puts "Response #{res.code} #{res.message}: #{res.body}"
{
"device":{
"id":2,
"serial_number":"111-222-333",
"enabled":true,
"framework_version":"5.10.2",
"meta":{
"brand":"pax",
"model":"d200",
"communication_media":"gprs",
"gprs_signal":"80",
"sim_card_id":"8955101234567890",
"os_version":"2.4.104",
"emv_kernel_version":"v602_01 2015.04.02",
"ssa_version":"",
"battery_level":"50",
"ssl":"on",
"signature":"production"
},
"updated_at":"2015-01-30T17:47:40Z",
"created_at":"2015-01-30T17:47:40Z",
"created_by":1,
"created_via":"interface"
}
}
Grant CloudWalk access to a new device.
POST https://api.cloudwalk.io/{version}/devices?access_token={token}
$ curl -X POST "https://api.cloudwalk.io/v1/devices?access_token=$TOKEN" \
-d '{"serial_number":"444-555-666"}'
require 'net/http'
require 'json'
token = 'API_TOKEN'
payload = {
"serial_number" => "444-555-666"
}
uri = URI("https://api.cloudwalk.io/v1/devices?access_token=#{token}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.request_uri)
request.body = payload.to_json
res = http.request(request)
puts "Response #{res.code} #{res.message}: #{res.body}"
{
"device":{
"id":3,
"serial_number":"444-555-666",
"enabled":true,
"framework_version":"5.10.2",
"meta":{
"brand":"pax",
"model":"d200",
"communication_media":"gprs",
"gprs_signal":"80",
"sim_card_id":"8955101234567893",
"os_version":"2.4.104",
"emv_kernel_version":"v602_01 2015.04.02",
"ssa_version":"",
"battery_level":"50",
"ssl":"on",
"signature":"production"
},
"updated_at":"2015-01-30T17:55:19Z",
"created_at":"2015-01-30T17:55:19Z",
"created_by":1,
"created_via":"api"
}
}
Update an existing device.
PUT https://api.cloudwalk.io/{version}/devices/{serial_number}?access_token={token}
$ curl -X PUT "https://api.cloudwalk.io/v1/devices/444-555-666?access_token=$TOKEN" \
-d '{"enabled":"false"}'
require 'net/http'
require 'json'
token = 'API_TOKEN'
payload = {
"enabled" => "false"
}
uri = URI("https://api.cloudwalk.io/v1/devices/444-555-666?access_token=#{token}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.new(uri.request_uri)
request.body = payload.to_json
res = http.request(request)
puts "Response #{res.code} #{res.message}: #{res.body}"
{
"device":{
"id":3,
"serial_number":"444-555-666",
"enabled":false,
"framework_version":"5.10.2",
"meta":{
"brand":"pax",
"model":"d200",
"communication_media":"gprs",
"gprs_signal":"80",
"sim_card_id":"8955101234567893",
"os_version":"2.4.104",
"emv_kernel_version":"v602_01 2015.04.02",
"ssa_version":"",
"battery_level":"50",
"ssl":"on",
"signature":"production"
},
"updated_at":"2015-01-30T17:58:59Z",
"created_at":"2015-01-30T17:55:19Z",
"created_by":1,
"created_via":"api"
}
}
Delete a device. The equipment with the deleted serial number will not be able to access CloudWalk.
DELETE https://api.cloudwalk.io/{version}/devices/{serial_number}?access_token={token}
$ curl -X DELETE "https://api.cloudwalk.io/v1/devices/444-555-666?access_token=$TOKEN"
require 'net/http'
token = 'API_TOKEN'
uri = URI("https://api.cloudwalk.io/v1/devices/444-555-666?access_token=#{token}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(uri.request_uri)
res = http.request(request)
puts "Response #{res.code} #{res.message}: #{res.body}"
{}