Listagem de Páginas da Loja

Requisição para a consulta de diversas páginas da loja.

Método GET

https://{api_address}/custom_pages

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $url = "https://{api_address}/custom_pages/?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>
string URLAuth = "https://{api_address}/custom_pages/";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
    
request.Credentials = CredentialCache.DefaultCredentials;
    
WebResponse response = request.GetResponse();
  
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
    
Stream dataStream = response.GetResponseStream();
    
StreamReader reader = new StreamReader(dataStream);

string responseData = reader.ReadToEnd();

Console.WriteLine(responseData);
reader.Close();
response.Close();
String url = "https://{api_address}/custom_pages/";

Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");

String queryString = "";

for (Entry<String, String> entry : mapToConvert.entrySet()) {
    queryString += entry.getKey()+"="+ entry.getValue()+"&";
}

try {
    URL obj = new URL(url+"?"+queryString);
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    
    con.setRequestMethod("GET");
    con.setRequestProperty("User-Agent", USER_AGENT);

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    StringBuilder response = new StringBuilder();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();
    
    String resposta = response.toString();

} catch (Exception ex){
    // Tratamento da Exception
}

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

Success 200

Campo Tipo Descrição
paging Object

Dados de paginação

  total Number

Total de registros

  page Number

Página corrente

  offset Number

Registro inicial da página

  limit Number

Limite de registros

  maxLimit Number

Máximo de registros

sort Object[]

Ordenação

availableFilters String[]

Filtros disponíveis

appliedFilters String[]

Filtros utilizados

CustomPages Object[]

Lista de páginas da loja

  CustomPage Object

Dados da página da loja

    id Number

Código da página da loja

    url String

URL da página

    info Number

Informações da página

    seo Number

Informações de SEO

    slug Number

Final da url da página

    active Number

Página ativa (Veja Tabela A)

    name Number

Nome da página

HTTP/1.1200 OK

{
"paging":{
"total":1,
"page":1,
"offset":0,
"limit":1,
"maxLimit":50
},
"sort":[
{
"id":"desc"
}
],
"availableFilters":[
"id",
"active"
],
"appliedFilters":[],
"CustomPages":[
{
"CustomPage":{
"id":"123",
"url":"/pagina-teste",
"info":"Página de Teste",
"seo":"Página Teste",
"slug":"pagina-teste",
"active":"1",
"name":"Página de teste"
}
}
]
}

Consultar Página da Loja

Requisição para a consulta de dados de uma página da loja.

Método GET

https://{api_address}/custom_pages/:id

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $url = "https://{api_address}/custom_pages/123?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>
string URLAuth = "https://{api_address}/custom_pages/123";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");    

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
    
request.Credentials = CredentialCache.DefaultCredentials;
    
WebResponse response = request.GetResponse();
  
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
    
Stream dataStream = response.GetResponseStream();
    
StreamReader reader = new StreamReader(dataStream);

string responseData = reader.ReadToEnd();

Console.WriteLine(responseData);
reader.Close();
response.Close();
String url = "https://{api_address}/custom_pages/123";

Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");

String queryString = "";

for (Entry<String, String> entry : mapToConvert.entrySet()) {
    queryString += entry.getKey()+"="+ entry.getValue()+"&";
}

try {
    URL obj = new URL(url+"?"+queryString);
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    
    con.setRequestMethod("GET");
    con.setRequestProperty("User-Agent", USER_AGENT);

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    StringBuilder response = new StringBuilder();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();
    
    String resposta = response.toString();

} catch (Exception ex){
    // Tratamento da Exception
}

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

:id Number

Código da página da loja

Success 200

Campo Tipo Descrição
CustomPage Object

Dados da página da loja

  id Number

Código da página da loja

  url String

URL da página

  conteudo Number

Conteúdo HTML da página

  info Number

Informações da página

  seo Number

Informações de SEO

  slug Number

Final da url da página

  active Number

Página ativa (Veja Tabela A)

  name Number

Nome da página

  default Number

Página padrão (Veja Tabela b)

HTTP/1.1200 OK
{"CustomPage":{"id":"123","url":"/pagina-teste","conteudo":"
\r\n

Pagina Teste

\r\n
\r\n","info":"Página de Teste","seo":"Página Teste","slug":"pagina-teste","active":"1","name":"Página de teste","default":"0"}}

Tabelas Auxiliares

Tabelas Auxiliares de Pedidos

Tabela A - Página da loja ativa (campo active)

Valor Descrição
0 Página inativa
1 Página ativa

Tabela B - Página padrão da loja (campo default)

Valor Descrição
0 Página adicional
1 Página padrão

 

Frontend - Agencia 
Tem mais dúvidas? Envie uma solicitação

Comentários

    Artigos nessa seção

    Powered by Zendesk