Solicitação

Solicitação HTTP

PUT http://www.minhasencomendas.com.br/api/v1

Parâmetros

A tabela a seguir contém a lista de parâmetros suportados por esta solicitação.

Parâmetros
Parâmetros obrigatórios
token string
Seu token de segurança para acessar a API de dados.

Observação:
  • Para gerá-lo é necessário estar cadastro.
  • Se você já está cadastrado, basta acessar a página do token para gerá-lo.
model string
Identifica esta solicitação.

O único valor aceitável é:
  • arquiva - arquiva/desarquiva uma encomenda conforme o código de identificação.
codigo string
Código de identificação da encomenda.
Informação fornecida pelos Correios.

Limite: 20 caracteres

Exemplo: SS123456789BR.
arquivado unsigned integer
Informa se a encomenda está arquivada.

Valores válidos:
  • 1 - arquivada.
  • 0 - não arquivada.

Resposta

Se for bem sucedido, este método retorna um corpo de resposta com a seguinte estrutura:

{
  "status": "ok"
}

Propriedades

A tabela a seguir define as propriedades que aparecem nesse recurso:

Propriedade
status string
Se a atualização for feita com sucesso o valor do status será ok.

Exemplo

O exemplo de código a seguir arquiva uma encomenda conforme os parâmetros de solicitação.

Este exemplo usa a biblioteca cliente PHP Minhas Encomendas.

<?php

require_once 'libraries/MinhasEncomendas.php';

$token = '8dffb5b37df02f6307fd'; // obrigatório

$api = new MinhasEncomendas($token);

/*
*  O token também poderá ser declarado pela função
*  $api->set_token($token);
*/
     
$parametros = array(
  'codigo' => 'SS123456789BR',
  'arquivado' => '1'
  
);

// faz a solicitação para arquivar uma 'encomenda' conforme os parâmetros fornecidos.
$responseJson = $api->put('arquiva', $parametros);

// converte o resultado JSON em ARRAY
$responseArray = json_decode($responseJson);

?>

Este exemplo usa a biblioteca cliente Javascript Minhas Encomendas.

<script type="text/javascript" src="js/MinhasEncomendas.js"></script>
<script>

var token = '8dffb5b37df02f6307fd'; // obrigatório

var api = new MinhasEncomendas(token);

/*
*  O token também poderá ser declarado pela função
*  api.setToken(token);
*/
     
var parametros = {
  'codigo' : 'SS123456789BR',
  'arquivado' : '1'
};

// faz a solicitação para atualizar uma 'encomenda' conforme os parâmetros fornecidos.
api.put('arquiva', parametros, function (data) {
   console.log(data);
});
</script>
            
curl -X PUT "http://www.minhasencomendas.com.br/api/v1/" 
     -d "token=8deeb4b36df01f5307fc&model=arquiva&codigo=SS123456789BR&arquivado=1"              
            

Comentários