Developer API - Grupos

  1. Atributos de um grupo
  2. Listagem de todos grupos
  3. Busca de um grupo específico
  4. Criação de um novo grupo
  5. Atualização de um grupo
  6. Exclusão de um grupo

Atributos de um grupo

Os seguintes atributos compõe um grupo:

Nome Tipo Descrição
id Integer ID do registro
name String Nome do grupo
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 grupos

Retorna um array com todos os grupos.

Método e formato da URL

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

Exemplo de utilização

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

token = 'API_TOKEN'

uri = URI("https://api.cloudwalk.io/v1/groups?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
   },
   "groups":[
      {
         "group":{
            "id":1,
            "name":"Retail",
            "updated_at":"2015-01-29T20:19:32Z",
            "created_at":"2015-01-29T20:19:32Z",
            "created_by":1,
            "created_via":"interface"
         }
      },
      {
         "group":{
            "id":2,
            "name":"Staging",
            "updated_at":"2015-01-29T20:19:44Z",
            "created_at":"2015-01-29T20:19:44Z",
            "created_by":1,
            "created_via":"interface"
         }
      }
   ]
}

Busca de um grupo específico

Retorna os detalhes de um grupo específico.

Método e formato da URL

GET https://api.cloudwalk.io/{versão}/groups/{nome do grupo}?access_token={token}

Exemplo de utilização

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

token = 'API_TOKEN'

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

{
  "group":{
    "id":2,
    "name":"Staging",
    "updated_at":"2015-01-29T20:19:44Z",
    "created_at":"2015-01-29T20:19:44Z",
    "created_by":1,
    "created_via":"interface"
  }
}

Criação de um novo grupo

Cria um novo grupo.

Método e formato da URL

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

Exemplo de utilização

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

token = 'API_TOKEN'

payload = { "name" => "Dev" }

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

{
  "group":{
    "id":3,
    "name":"Dev",
    "updated_at":"2015-01-29T20:23:08Z",
    "created_at":"2015-01-29T20:23:08Z",
    "created_by":1,
    "created_via":"api"
  }
}

Atualização de um grupo

Modifica um grupo já existente.

Método e formato da URL

PUT https://api.cloudwalk.io/{versão}/groups/{nome do grupo}?access_token={token}

Exemplo de utilização

$ curl -X PUT "https://api.cloudwalk.io/v1/groups/Dev?access_token=$TOKEN" \
-d '{"name":"Development"}'
require 'net/http'
require 'json'

token = 'API_TOKEN'

payload = { "name" => "Development" }

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

{
  "group":{
    "id":3,
    "name":"Development",
    "updated_at":"2015-01-29T20:25:14Z",
    "created_at":"2015-01-29T20:23:08Z",
    "created_by":1,
    "created_via":"api"
  }
}

Exclusão de um grupo

Exclui um grupo. Esta operação só pode ser executada quando o grupo estiver vazio (sem aplicações ou número lógicos).

Método e formato da URL

DELETE https://api.cloudwalk.io/{versão}/groups/{nome do grupo}?access_token={token}

Exemplo de utilização

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

token = 'API_TOKEN'

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

{}