Consultar Informações da Loja

Requisição para consultar os dados de diversas formas de envio.

Método GET

https://{api_address}/info/

Código de Exemplo

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

    $url = "https://{api_address}/info/?".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}/info/";

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}/info/";

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âmetros enviados

Field Type Description
access_token String

Chave de acesso

Retorno em caso de sucesso (status code 200 ou 201)

Field Type Description
id Number

Código da loja

name String

Nome da loja

company_name String

Razão social

cnpj String

CNPJ

address String

Logradouro

postal_code String

CEP

city String

Cidade

state String

Estado

country String

País

phone_number_1 String

Número de telefone 1

phone_number_2 String

Número de telefone 2

phone_number_3 String

Número de telefone 3

email_1 String

Email 1

email_2 String

Email 2

office_hour String

Horário de operação

uri String

URL da loja

secure_uri String

URL segura da loja

logo Object

Logo da loja

  http String

URL do logo da loja

  https String

URL segura do logo da loja

logo_mobile Object

Logo da loja (mobile)

  http String

URL do logo da loja (mobile)

  https String

URL segura do logo da loja (mobile)

user String

Usuário

internal_status String

Status da loja

favicon Object

Favicon da loja

  http String

URL do favicon da loja

  https String

URL segura do favicon da loja

messages Object

Mensagens da loja

  footer String

Mensagem do rodapé

Json de Retorno

HTTP/1.1 200 OK
{
    "id": "123",
    "name": "Nome da Loja",
    "company_name": "Razão Social da Loja LTDA",
    "cnpj": "00.000.000/0000-00",
    "address": "Endereço da loja, 123",
    "postal_code": "04001-001",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil",
    "phone_number_1": "(11)3333-0000",
    "phone_number_2": "(11)99999-0000",
    "phone_number_3": "",
    "email_1": "emailda@loja.com.br",
    "email_2": "",
    "office_hour": "",
    "uri": "http://loja.commercesuite.com.br",
    "secure_uri": "https://loja.commercesuite.com.br",
    "logo": {
        "http": "http://images.tcdn.com.br/img/img_prod/123/123_logotipo.png",
        "https": "https://images.tcdn.com.br/img/img_prod/123/123_logotipo.png"
    },
    "logo_mobile": {
        "http": "http://images.tcdn.com.br/img/arquivos/123/themed/img/123_logotipo-mobile.png",
        "https": "https://images.tcdn.com.br/img/arquivos/123/themed/img/123_logotipo-mobile.png"
    },
    "user": "",
    "internal_status": "ativa",
    "favicon": {
        "http": "http://images.tcdn.com.br/img/img_prod/123/123_favicon.ico",
        "https": "https://images.tcdn.com.br/img/img_prod/123/123_favicona.ico"
    },
    "messages": {
        "footer": "Mensagem do rodapé da loja."
    }
}
 
Frontend - Agencia 
Tem mais dúvidas? Envie uma solicitação

Comentários

    Artigos nessa seção

    Powered by Zendesk