Developer API - Usuários

  1. Atributos de um usuário
  2. Listagem de todos usuários
  3. Busca de um usuário específico
  4. Obter a API Token de um usuário específico

Atributos de um usuário

Os seguintes atributos compõe um usuário:

Nome Tipo Descrição
id Integer ID do registro
email String E-mail da conta
name String Nome do usuário
sign_in_count Integer Quantidade de autenticações (sign-in) realizadas
last_sign_in_at String Timestamp da criação da última sessão (ISO 8601)
last_sign_in_ip String IP utilizado na última sessão
time_zone String Time zone utilizado no CloudWalk Manager (padrão UTC)
updated_at String Timestamp da atualização do registro (ISO 8601)
created_at String Timestamp da criação do registro (ISO 8601)

Listagem de todos usuários

Retorna um array com todos os usuários.

Método e formato da URL

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

Exemplo de utilização

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

token = 'API_TOKEN'

uri = URI("https://api.cloudwalk.io/v1/users?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
   },
   "users":[
      {
         "user":{
            "id":1,
            "email":"[email protected]",
            "name":"Clark Kent",
            "sign_in_count":4,
            "last_sign_in_at":"2015-01-29T17:42:26Z",
            "last_sign_in_ip":"127.0.0.1",
            "time_zone":"America/Chicago",
            "updated_at":"2015-01-30T15:02:49Z",
            "created_at":"2015-01-26T17:47:35Z"
         }
      },
      {
         "user":{
            "id":3,
            "email":"[email protected]",
            "name":"Bruce Wayne",
            "sign_in_count":1,
            "last_sign_in_at":"2015-01-30T15:06:06Z",
            "last_sign_in_ip":"127.0.0.1",
            "time_zone":"America/Chicago",
            "updated_at":"2015-01-30T15:06:37Z",
            "created_at":"2015-01-30T15:04:27Z"
         }
      }
   ]
}

Busca de um usuário específico

Retorna os detalhes de um usuário específico.

Método e formato da URL

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

Exemplo de utilização

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

token = 'API_TOKEN'

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

{
  "user":{
    "id":3,
    "email":"[email protected]",
    "name":"Bruce Wayne",
    "sign_in_count":1,
    "last_sign_in_at":"2015-01-30T15:06:06Z",
    "last_sign_in_ip":"127.0.0.1",
    "time_zone":"America/Chicago",
    "updated_at":"2015-01-30T15:06:37Z",
    "created_at":"2015-01-30T15:04:27Z"
  }
}

Obter a API Token de um usuário específico

É possível obter a API Token de um usuário apartir do e-mail e senha do usuário em questão.

Método e formato da URL

POST https://api.cloudwalk.io/{versão}/users/token

Exemplo de utilização

$ curl -X POST "https://api.cloudwalk.io/v1/users/token" \
-d '{"email":"[email protected]","password":"batman"}'

require 'net/http'
require 'json'

payload = {
  "email" => "[email protected]",
  "password" => "batman"
}

uri = URI("https://api.cloudwalk.io/v1/users/token")

req = Net::HTTP::Post.new(uri.request_uri)

req['Content-Type'] = "application/json"

req.body = payload.to_json

res = Net::HTTP.start(uri.hostname, uri.port) { |http|
  http.request(req)
}

puts "Response #{res.code} #{res.message}: #{res.body}"

Exemplo de resposta

[
  {
    "company_name":"Wayne Enterprises",
    "company_id":1,
    "api_token":"78562f2ba49ce71ae966f23922a7c3692e3b9ay2"
  }
]