×
Entrar
Experimente grátis
Top

GET/depositos

  • 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 todos os depósitos

Recupera todos os depósitos cadastrados no sistema.

curl    

 
curl -X GET "https://bling.com.br/Api/v2/depositos/json/"
     -G
     -d "apikey={apikey}" 

PHP

 
 $apikey = "{apikey}";
$outputType = "json";
$url = 'https://bling.com.br/Api/v2/depositos/' . $outputType;
$retorno = executeGetDeposits($url, $apikey);
echo $retorno;
function executeGetDeposits($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 ExecuteGetDeposits() {
    var request = HttpWebRequest.Create(@"https://bling.com.br/Api/v2/depositos/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 Sua apikey string  
situacao Parâmetro opcional para filtrar por situações do depósito (A = ativo, I = inativo) A ou I
 

Retorno

Em caso de sucesso, retornará todas os depósitos registrados(ou filtrados pela situacao), no mesmo modelo do exemplo a seguir. Caso contrário, retornará um erro.

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

Exemplo de retorno

  "retorno":{  
      "depositos":[  
         {  
            "deposito":{  
               "id": 792,
               "descricao": "Depósito Geral",
               "situacao": "Inativo",
               "depositoPadrao": "false",
               "desconsiderarSaldo": "false"                
            }
         }
      ]
   }
}

Artigos relacionados