Developer API - Números lógicos

  1. Atributos de um número lógico
  2. Listagem de todos números lógicos
  3. Busca de um número lógico específico
  4. Criação de um novo número lógico
  5. Atualização de um número lógico
  6. Exclusão de um número lógico

Atributos de um número lógico

Os seguintes atributos compõe um número lógico:

Nome Tipo Descrição
id Integer ID do registro
number String Número lógico
group_id Integer ID do grupo que o número lógico pertence
app_version_ids Integer (array) Lista com o ID da versão dos aplicativos (do grupo) que o número lógico tem acesso
updated_at String Timestamp da atualização do registro (ISO 8601)
created_at String Timestamp da criação do registro (ISO 8601)
created_by Integer ID do usuário que criou o registro
created_via String Canal utilizado para criar o registro (Interface ou API)

Listagem de todos números lógicos

Retorna um array com todos os números lógicos.

Método e formato da URL

GET https://api.cloudwalk.io/{versão}/logical_numbers?access_token={token}

Exemplo de utilização

$ curl -X GET "https://api.cloudwalk.io/v1/logical_numbers?access_token=$TOKEN"
require 'net/http'

token = 'API_TOKEN'

uri = URI("https://api.cloudwalk.io/v1/logical_numbers?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}"

Exemplo de resposta

{
   "pagination":{
      "page":1,
      "total_pages":1,
      "entries":2,
      "total_entries":2
   },
   "logical_numbers":[
      {
         "logical_number":{
            "id":1,
            "number":"112233",
            "group_id":null,
            "app_version_ids":[],
            "updated_at":"2015-03-02T18:59:14Z",
            "created_at":"2015-03-02T18:59:14Z",
            "created_by":1,
            "created_via":"interface"
         }
      },
      {
         "logical_number":{
            "id":2,
            "number":"445566",
            "group_id":null,
            "app_version_ids":[],
            "updated_at":"2015-03-02T18:59:29Z",
            "created_at":"2015-03-02T18:59:29Z",
            "created_by":1,
            "created_via":"interface"
         }
      }
   ]
}

Busca de um número lógico específico

Retorna os detalhes de um número lógico específico.

Método e formato da URL

GET https://api.cloudwalk.io/{versão}/logical_numbers/{logical_number}?access_token={token}

Exemplo de utilização

$ curl -X GET "https://api.cloudwalk.io/v1/logical_numbers/445566?access_token=$TOKEN"
require 'net/http'

token = 'API_TOKEN'

uri = URI("https://api.cloudwalk.io/v1/logical_numbers/445566?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}"

Exemplo de resposta

{
  "logical_number":{
    "id":2,
    "number":"445566",
    "group_id":null,
    "app_version_ids":[],
    "updated_at":"2015-03-02T18:59:29Z",
    "created_at":"2015-03-02T18:59:29Z",
    "created_by":1,
    "created_via":"interface"
  }
}

Criação de um novo número lógico

Cria um novo número lógico.

Método e formato da URL

POST https://api.cloudwalk.io/{versão}/logical_numbers?access_token={token}

Exemplo de utilização

$ curl -X POST "https://api.cloudwalk.io/v1/logical_numbers?access_token=$TOKEN" \
-d '{"number":"778899"}'
require 'net/http'
require 'json'

token = 'API_TOKEN'

payload = { "number" => "778899" }

uri = URI("https://api.cloudwalk.io/v1/logical_numbers?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}"

Exemplo de resposta

{
  "logical_number":{
    "id":3,
    "number":"778899",
    "group_id":null,
    "updated_at":"2015-03-02T19:17:19Z",
    "created_at":"2015-03-02T19:17:19Z",
    "created_by":1,
    "created_via":"api"
  }
}

Atualização de um número lógico

Modifica um número lógico já existente.

Método e formato da URL

PUT https://api.cloudwalk.io/{versão}/logical_numbers/{logical_number}?access_token={token}

Exemplo de utilização

$ curl -X PUT "https://api.cloudwalk.io/v1/logical_numbers/778899?access_token=$TOKEN" \
-d '{"number":"889900"}'
require 'net/http'
require 'json'

token = 'API_TOKEN'

payload = { "number" => "889900" }

uri = URI("https://api.cloudwalk.io/v1/logical_numbers/778899?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}"

Exemplo de resposta

{
  "logical_number":{
    "id":3,
    "number":"889900",
    "group_id":null,
    "app_version_ids":[],
    "updated_at":"2015-03-02T19:20:27Z",
    "created_at":"2015-03-02T19:17:19Z",
    "created_by":1,
    "created_via":"api"
  }
}

Exclusão de um número lógico

Exclui um número lógico. O equipamento com o número lógico excluído não conseguirá mais baixar aplicativos do CloudWalk.

Método e formato da URL

DELETE https://api.cloudwalk.io/{versão}/logical_numbers/{logical_number}?access_token={token}

Exemplo de utilização

$ curl -X DELETE "https://api.cloudwalk.io/v1/logical_numbers/889900?access_token=$TOKEN"
require 'net/http'

token = 'API_TOKEN'

uri = URI("https://api.cloudwalk.io/v1/logical_numbers/889900?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}"

Exemplo de resposta

{}