Developer API - Aplicações

  1. Tipos de aplicações
  2. Atributos de uma aplicação
  3. Listagem de todas aplicações
  4. Busca de uma aplicação específica
  5. Criação de uma nova aplicação
  6. Modificação de uma aplicação
  7. Exclusão de uma aplicação

Tipos de aplicações

Atualmente somente aplicações POSXML são suportadas, mas em breve aplicações Ruby também estarão disponíveis, então requisições de aplicação devem sempre indicar o tipo.

Atributos de uma aplicação

Os seguintes atributos compõe uma aplicação:

Nome Tipo Descrição
id Integer ID do registro
name String Nome da aplicação
description String Breve descrição da aplicação
communication_format String Formato da comunicação com o autorizador (HTTP, ISO8583 ou ISO20022)
updated_at String Timestamp da atualização do registro (ISO 8601)
created_via String Canal utilizado para criar o registro (Interface ou API)
kind String Tipo da aplicação (Standard ou Module).

Listagem de todas aplicações

Retorna um array com todas as aplicações.

Método e formato da URL

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

Exemplo de utilização

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

token = 'API_TOKEN'

uri = URI("https://api.cloudwalk.io/v1/apps/posxml?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
   },
   "posxml_apps":[
      {
         "posxml_app":{
            "id":172,
            "name":"helloworld.posxml",
            "description":"Hello World",
            "communication_format":"http",
            "updated_at":"2015-01-30T12:09:49-03:00",
            "created_via":"interface"
            "kind":"standard"
         }
      },
      {
         "posxml_app":{
            "id":173,
            "name":"sample.posxml",
            "description":"Sample App",
            "communication_format":"http",
            "updated_at":"2015-01-30T12:13:26-03:00",
            "created_via":"interface"
            "kind":"standard"
         }
      }
   ]
}

Busca de uma aplicação específica

Retorna os detalhes de uma aplicação específica.

Método e formato da URL

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

Exemplo de utilização

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

token = 'API_TOKEN'

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

{
  "posxml_app":{
    "id":172,
    "name":"helloworld.posxml",
    "description":"Hello World",
    "communication_format":"http",
    "updated_at":"2015-01-30T12:09:49-03:00",
    "created_via":"interface"
    "kind":"standard"
  }
}

Criação de uma nova aplicação

Cria uma nova aplicação.

Método e formato da URL

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

Exemplo de utilização

$ curl -X POST "https://api.cloudwalk.io/v1/apps/posxml?access_token=$TOKEN" \
-d '{"name":"newapp","description":"desc","kind":"standard","communication_format":"http"}'
require 'net/http'
require 'json'

token = 'API_TOKEN'

payload = {
  "name" => "sample",
  "description" => "Sample App",
  "kind" => "standard",
  "communication_format" => "http"
}

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

{
  "posxml_app":{
    "id":173,
    "name":"sample.posxml",
    "description":"Sample App",
    "communication_format":"http",
    "updated_at":"2015-01-30T12:13:26-03:00",
    "created_via":"interface"
    "kind":"standard"
  }
}

Modificação de uma aplicação

Modifica uma aplicação já existente.

Método e formato da URL

PUT https://api.cloudwalk.io/{versão}/apps/{tipo}/{app_id}?access_token={token}

Exemplo de utilização

$ curl -X PUT "https://api.cloudwalk.io/v1/apps/posxml/173?access_token=$TOKEN" \
-d '{"description":"New Description"}'
require 'net/http'
require 'json'

token = 'API_TOKEN'

payload = {
  "description" => "New Description"
}

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

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

Exemplo de resposta

{
  "posxml_app":{
    "id":173,
    "name":"sample.posxml",
    "description":"New Description",
    "communication_format":"http",
    "updated_at":"2015-01-30T12:13:26-03:00",
    "created_via":"interface"
    "kind":"standard"
  }
}

Exclusão de uma aplicação

Exclui uma aplicação.

Método e formato da URL

DELETE https://api.cloudwalk.io/{versão}/apps/{tipo}/{app_id}?access_token={token}

Exemplo de utilização

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

token = 'API_TOKEN'

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

{}