A API V3 JÁ ESTÁ DISPONÍVEL
As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente. |
Atualiza um depósito
Atualiza um depósito a partir do seu id.
curl |
curl -X POST "https://bling.com.br/Api/v2/deposito/{idDeposito}/json/" |
PHP |
$url = 'https://bling.com.br/Api/v2/deposito/{idDeposito}/'; $xml = '>...'; $posts = array ( "apikey" => "{apikey}", "xml" => rawurlencode($xml) ); $retorno = executeUpdateDeposit($url, $posts); echo $retorno; function executeUpdateDeposit($url, $data){ $curl_handle = curl_init(); curl_setopt($curl_handle, CURLOPT_URL, $url); curl_setopt($curl_handle, CURLOPT_POST, count($data)); curl_setopt($curl_handle, CURLOPT_POSTFIELDS, $data); curl_setopt($curl_handle, CURLOPT_RETURNTRANSFER, TRUE); $response = curl_exec($curl_handle); curl_close($curl_handle); return $response; } |
C# |
public static void ExecuteUpdateDeposit() { HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://bling.com.br/Api/v2/deposito/{idDeposito}"); ASCIIEncoding encoding = new ASCIIEncoding(); string postData = "apikey={apiKey}&xml={xml_do_deposito}"; byte[] data = encoding.GetBytes(postData); request.Method = "POST"; request.ContentType = "application/x-www-form-urlencoded"; request.ContentLength = data.Length; using (Stream stream = request.GetRequestStream()) stream.Write(data,0,data.Length); HttpWebResponse response = (HttpWebResponse)request.GetResponse(); string responseString = new StreamReader(response.GetResponseStream()).ReadToEnd(); Console.Out.WriteLine("Response Body: \r\n {0}", responseString); } |
Parâmetro | Descrição | Tipo |
apikey |
apikey gerada no sistema | string |
xml |
Xml contendo o depósito | string |
Para o parâmetro xml
, é necessário seguir o padrão.
Tabela de campos do XML
Grupo | Campo | Informação | Tipo | Padrão | Opcional |
raiz | depositos | Obrigatório | |||
depositos | deposito | Obrigatório | |||
deposito | descricao | Descrição do depósito | String(120) | Obrigatório | |
deposito | desconsiderarSaldo | Desconsidera saldo deste depósito | boolean | false | Opcional |
deposito | depositoPadrao | Define se o depósito vai ser o padrão | boolean | false | Opcional |
deposito | situacao | Situação do depósito | String(1) , (A ou I) | A | Obrigatório |
Mensagens de erros específicos
Código | Mensagem |
---|---|
100 | Não foi possível salvar as informações do depósito |
101 | O campo descrição é obrigatório |
102 | Não foi possível atualizar o depósito - Depósito não encontrado no sistema |
104 | Já existe um depósito com estas informações cadastrado |
105 | O campo situação é obrigatório |
106 | Não é permitido remover a informação de depósito padrão ou inativá-lo |
107 | O campo situação está inválido |
Exemplo de XML
<depositos>
<deposito>
<descricao>Depósito Padrão</descricao>
<situacao>A</situacao>
<depositoPadrao>true</depositoPadrao>
<desconsiderarSaldo>false</desconsiderarsaldo>
</deposito>
</depositos>
Retorno
Em caso de sucesso, retornará o depósito alterado, 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": "Geral", "situacao": "Inativo", "depositoPadrao" : "false", "considerarSaldo" : "false" } } ] } }