×
Entrar
Experimente grátis
Top

GET /camposcustomizados/{módulo}

  • Atualizado
Seguir

A API V3 JÁ ESTÁ DISPONÍVEL


A API v2 foi descontinuada e não receberá mais atualizações.

Acesse a documentação da API v3 link-externo.png

Info- icon-P.png As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente.
Realize a migração para a nova versão o mais breve possível. Consulte o calendário link-externo.png

 

Busca os campos customizados a partir do seu módulo.

 

curl

 
curl -X GET "https://bling.com.br/Api/v2/camposcustomizados/{módulo}/json/"

        
     -G

     -d "apikey={apikey}"

PHP

 
$apikey = "{apikey}";

$modulo = "{módulo}";

$outputType = "json";

$url = 'https://bling.com.br/Api/v2/camposcustomizados/' . $modulo . '/' . $outputType;

$retorno = executeGetFields($url, $apikey);

echo $retorno;

function executeGetFields($url, $apikey){

 $curl_handle = curl_init();

 curl_setopt($curl_handle, CURLOPT_URL, $url . '&apikey=' . $apikey);

 curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, TRUE);

 $response = curl_exec($curl_handle);

 curl_close($curl_handle);

 return $response;

}

C#

 
public static void ExecuteGetFields() {

 var request = HttpWebRequest.Create(@"https://bling.com.br/Api/v2/camposcustomizados/Vendas/json&apikey={apikey}");

 request.ContentType = "application/json";

 request.Method = "GET";

 using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)

 {

 if (response.StatusCode != HttpStatusCode.OK)

 Console.Out.WriteLine("Error. Server returned status code: {0}", response.StatusCode);

 using (StreamReader reader = new StreamReader(response.GetResponseStream()))

 {

 var content = reader.ReadToEnd();

 if(string.IsNullOrWhiteSpace(content))

 Console.Out.WriteLine("Empty Response");

 else

 Console.Out.WriteLine("Response Body: \r\n {0}", content);

 }

 }

}

 

Parâmetro   Descrição Tipo
apikey API key gerada no sistema. string
módulo Módulo dos campos que você deseja consultar. Utilizar o nome exibido na tabela de módulos. string
 

Tabela de módulos

Nome Módulo
Produtos     Produtos   
OrdemServico    Ordem de Serviço   
Contatos Contatos
 
 

Retorno

Em caso de sucesso, retornará os campos do módulo especificado, no mesmo modelo do exemplo a seguir. Caso contrário, retornará um erro.

A resposta será no formato especificado na URL (XML ou JSON).

{
     "retorno": {
        "camposcustomizados": [
            {
                "campoCustomizado": {
                    "id": "1",
                    "alias": "memoriaRam",
                    "nome": "Memória RAM",
                    "descricao": "Memória RAM (GB) do dispositivo",
                    "situacao": true,
                    "tipoCampo": "inteiro",
                    "obrigatorio": true,
                    "tamanhoMinimo": null,
                    "tamanhoMaximo": null,
                    "agrupadores": [
                      {
                           "agrupador": {
                                "id": "26754",
                                "nome": "Celulares e Smartphones"
                                }
                       }
                ]
        }
 },
                 "campoCustomizado": {
                     "id": "2",
                     "alias": "eDualSim",
                     "nome": "É Dual SIM",
                     "descricao": "Campo para informar se este dispositivo aceita 
dois cartões SIM",
                     "situacao": true,
                     "tipoCampo": "binario",
                     "obrigatorio": false,
                     "tamanhoMinimo": null,
                     "tamanhoMaximo": null,
                     "agrupadores": [
                          {
                            "agrupador": {
                                "id": "26754",
                                "nome": "Celulares e Smartphones"
                                }
                           }
                       ]
                   }
              },
          ]
      }
}

Artigos relacionados