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 é:
  • vendas - retorna os dados de personalização dos emails de notificações de rastreio que serão enviadas para seus clientes.
remetente string
Nome do remetente que aparecerá nas notificações.

Limite: 30 caracteres

Exemplo: Minha Empresa (Nome Fantasia)
email string
Email de envio das notificações.

Limite: 50 caracteres

Exemplo: vendas@minhaempresa.com.br

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 os dados do Módulo Vendas foram atualizados com sucesso o valor do status será ok.

Exemplo

O exemplo de código a seguir atualiza os dados do Módulo Vendas conforme os parâmetros de solitaçã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(
  'remetente' => 'Minha Empresa (Nome Fantasia)',
  'email' => 'vendas@minhaempresa.com.br'
);

// faz a solicitação para atualizar os dados do Módulo Vendas conforme os parâmetros fornecidos.
$responseJson = $api->put('vendas', $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 = {
  'remetente' : 'Minha Empresa (Nome Fantasia)',
  'email' : 'vendas@minhaempresa.com.br'
};

// faz a solicitação para atualizar os dados do Módulo Vendas conforme os parâmetros fornecidos.
api.put('vendas', parametros, function (data) {
   console.log(data);
});
</script>
            
curl -X PUT "http://www.minhasencomendas.com.br/api/v1/" 
     -d "token=8deeb4b36df01f5307fc&model=vendas&remetente=Minha Empresa (Nome Fantasia)&email=vendas@minhaempresa.com.br"
            

Comentários