Solicitação

Solicitação HTTP

GET 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.

Resposta

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

{
  "status": "ok",
  "vendas": 
    {
      "remetente": string,
      "email": string
    }
}

Propriedades

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

Propriedade
status string
Se a resposta for bem sucedida o valor do status será ok.
vendas object
Retorna os dados de personalização dos emails de notificações de rastreio que serão enviadas para seus clientes.
vendas.remetente string
Nome do remetente que aparecerá nas notificações.

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

Exemplo: vendas@minhaempresa.com.br

Exemplo

O exemplo de código a seguir faz a solicitação que retorna os dados do Módulos Vendas.

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);
*/
     
// faz a solicitação dos dados do Módulo Vendas.
$responseJson = $api->get('vendas');

// 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);
*/
     
// faz a solicitação dos dados do Módulo Vendas.
api.get('vendas', function (data) {
   console.log(data);
});
</script>
            
curl -X GET "http://www.minhasencomendas.com.br/api/v1/" 
     -G 
     -d "token=8deeb4b36df01f5307fc&model=vendas"
            

Comentários