Um metaconteúdo pode ser referente a um número lógico ou a um grupo. O que irá determinar que tipo de metaconteúdo está sendo tratado é a definição do number (refere-se a um número lógico) ou do name (refere-se a um grupo).
Os seguintes atributos compõe um metaconteúdo:
Nome | Tipo | Descrição |
---|---|---|
id | Integer | ID do registro |
key | String | Chave do meta conteúdo |
value | JSON | Valor do metaconteúdo |
group_id | Integer | ID do grupo, se o meta conteúdo pertencer a um grupo |
logical_number_id | Integer | ID do número lógico, se o metaconteúdo pertencer a um número lógico |
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) |
Retorna um array com todos os metaconteúdos de um grupo ou de um número lógico.
GET https://api.cloudwalk.io/{versão}/metacontents?access_token={token}
$ curl -X GET "https://api.cloudwalk.io/v1/metacontents?access_token=$TOKEN" \
-d '{"name":"Dev"}'
$ curl -X GET "https://api.cloudwalk.io/v1/metacontents?access_token=$TOKEN" \
-d '{"number":"778899"}'
require 'net/http'
require 'json'
token = 'API_TOKEN'
payload = {
# "name" => "Dev" # Grupo
"number" => "778899" # Número lógico
}
uri = URI("https://api.cloudwalk.io/v1/metacontents?access_token=#{token}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
request.body = payload.to_json
res = http.request(request)
puts "Response #{res.code} #{res.message}: #{res.body}"
{
"pagination":{
"page":1,
"total_pages":1,
"entries":2,
"total_entries":2
},
"metacontents":[
{
"logical_number_metacontent":{
"id":2,
"key":"activation",
"value":{
"merchant_id":1000,
"enabled":true,
"soft_descriptor":"SAMPLE"
}
"group_id":null,
"logical_number_id":4,
"updated_at":"2015-03-02T22:51:40Z",
"created_at":"2015-03-02T22:51:40Z",
"created_by":1,
"created_via":"api"
}
},
{
"logical_number_metacontent":{
"id":3,
"key":"extra",
"value":{
"document":"11.222.333/0004-55",
"name":"Merchant Sample"
},
"group_id":null,
"logical_number_id":4,
"updated_at":"2015-03-02T11:26:30Z",
"created_at":"2015-03-02T11:26:30Z",
"created_by":1,
"created_via":"interface"
}
}
]
}
Retorna os detalhes de um metaconteúdo específico.
GET https://api.cloudwalk.io/{versão}/metacontents/{metacontent_id}?access_token={token}
$ curl -X GET "https://api.cloudwalk.io/v1/metacontents/1?access_token=$TOKEN" \
-d '{"name":"Dev"}'
$ curl -X GET "https://api.cloudwalk.io/v1/metacontents/3?access_token=$TOKEN" \
-d '{"number":"778899"}'
require 'net/http'
require 'json'
token = 'API_TOKEN'
payload = {
# "name" => "Dev" # Grupo
"number" => "778899" # Número lógico
}
uri = URI("https://api.cloudwalk.io/v1/metacontents/1?access_token=#{token}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri.request_uri)
request.body = payload.to_json
res = http.request(request)
puts "Response #{res.code} #{res.message}: #{res.body}"
{
"logical_number_metacontent":{
"id":3,
"key":"extra",
"value":{
"document":"11.222.333/0004-55",
"name":"Merchant Sample"
},
"group_id":null,
"logical_number_id":4,
"updated_at":"2015-03-02T11:26:30Z",
"created_at":"2015-03-02T11:26:30Z",
"created_by":1,
"created_via":"interface"
}
}
Cria um novo metaconteúdo.
POST https://api.cloudwalk.io/{versão}/metacontents?access_token={token}
$ curl -X POST "https://api.cloudwalk.io/v1/metacontents?access_token=$TOKEN" \
-d '{"name":"Dev","key":"fees","value":{"one":1.85,"two":2.09,"three":2.18}}'
$ curl -X POST "https://api.cloudwalk.io/v1/metacontents?access_token=$TOKEN" \
-d '{"number":"778899","key":"fees","value":{"one":1.85,"two":2.09,"three":2.18}}'
require 'net/http'
require 'json'
token = 'API_TOKEN'
payload = {
# "name" => "Dev", # Grupo
"number" => "778899", # Número lógico
"key" => "fees",
"value" => {
"one" => 1.85,
"two" => 2.09,
"three" => 2.18
}
}
uri = URI("https://api.cloudwalk.io/v1/metacontents?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}"
{
"logical_number_metacontent":{
"id":5,
"key":"fees",
"value":{
"one":1.85,
"two":2.09,
"three":2.18
},
"group_id":null,
"logical_number_id":4,
"updated_at":"2015-03-02T11:58:53Z",
"created_at":"2015-03-02T11:58:53Z",
"created_by":1,
"created_via":"api"
}
}
Modifica um metaconteúdo já existente.
PUT https://api.cloudwalk.io/{versão}/metacontents/{metacontent_id}?access_token={token}
$ curl -X PUT "https://api.cloudwalk.io/v1/metacontents/1?access_token=$TOKEN" \
-d '{"name":"Dev","key":"fees","value":{"one":1.90,"two":2.15,"three":2.25}}'
$ curl -X PUT "https://api.cloudwalk.io/v1/metacontents/3?access_token=$TOKEN" \
-d '{"number":"778899","fees","value":{"one":1.90,"two":2.15,"three":2.25}}'
require 'net/http'
require 'json'
token = 'API_TOKEN'
payload = {
# "name" => "Dev", # Grupo
"number" => "778899",
"key" => "fees",
"value" => {
"one" => 1.90,
"two" => 2.15,
"three" => 2.25
}
}
uri = URI("https://api.cloudwalk.io/v1/metacontents/3?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}"
{
"logical_number_metacontent":{
"id":3,
"key":"fees",
"value":{
"one":1.90,
"two":2.15,
"three":2.25
},
"group_id":null,
"logical_number_id":4,
"updated_at":"2015-03-02T12:36:39Z",
"created_at":"2015-03-02T11:26:30Z",
"created_by":1,
"created_via":"interface"
}
}
Exclui um metaconteúdo.
DELETE https://api.cloudwalk.io/{versão}/metacontents/{metacontent_id}?access_token={token}
$ curl -X DELETE "https://api.cloudwalk.io/v1/metacontents/1?access_token=$TOKEN" \
-d '{"name":"Dev"}'
$ curl -X DELETE "https://api.cloudwalk.io/v1/metacontents/3?access_token=$TOKEN" \
-d '{"number":"778899"}'
require 'net/http'
require 'json'
token = 'API_TOKEN'
payload = {
# "name" => "Dev" # Grupo
"number" => "778899" # Número lógico
}
uri = URI("https://api.cloudwalk.io/v1/metacontents/1?access_token=#{token}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(uri.request_uri)
request.body = payload.to_json
res = http.request(request)
puts "Response #{res.code} #{res.message}: #{res.body}"
{}