Developer API - Applications

  1. Application types
  2. Application attributes
  3. List of all applications
  4. Find a specific application
  5. Create a new application
  6. Update an application
  7. Delete an application

Application types

Currently only POSXML apps are supported, but soon Ruby apps will be available as well, so app requests should always indicate the app type.

Application attributes

An application has the following attributes:

Name Type Description
id Integer Record ID
name String Application name
description String Brief description
communication_format String Authorizer communication format (HTTP, ISO8583 or ISO20022).
updated_at String Timestamp in ISO 8601 format
created_via String Channel used to create the record (Interface or API)
kind String Application type (Standard or Module)

List of all applications

Return an array with all applications.

Method and URL format

GET https://api.cloudwalk.io/{version}/apps/{type}?access_token={token}

Example of use

$ 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}"

Example of response

{
   "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"
         }
      }
   ]
}

Find a specific application

Return the details of a specific application.

Method and URL format

GET https://api.cloudwalk.io/{version}/apps/{type}/{app_id}?access_token={token}

Example of use

$ 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}"

Example of response

{
  "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"
  }
}

Create a new application

Create a new application.

Method and URL format

POST https://api.cloudwalk.io/{version}/apps/{type}?access_token={token}

Example of use

$ 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}"

Example of response

{
  "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"
  }
}

Update an application

Update an existing application.

Method and URL format

PUT https://api.cloudwalk.io/{version}/apps/{type}/{app_id}?access_token={token}

Example of use

$ 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}"

Example of response

{
  "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"
  }
}

Delete an application

Delete an application.

Method and URL format

DELETE https://api.cloudwalk.io/{version}/apps/{type}/{app_id}?access_token={token}

Example of use

$ 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}"

Example of response

{}