API de Transações

Obter Todas Transações

Antes de prosseguir, certifique-se que leu todos os tópicos seção Primeiros Passos.

Estrutura

Para obter todas as transações é utilizada a estrutura, conforme Tabela 01:

Tabela 01 - Obter Transações
Método GET
URL https://api.asteroidetecnologia.com.br
Recurso /transactions/all
Query (filtros) Ver opções na Tabela 02.
Endpoint https://api.asteroidetecnologia.com.br/transactions/all
Caso seja utilizado algum filtro, como data_pedido_ini e data_pedido_fim, ficaria algo como: https://api.asteroidetecnologia.com.br/transactions/all?data_pedido_ini=2019-01-01&data_pedido_fim=2019-01-31

Exemplos

Veja alguns exemplos de como realizar uma requisição à API de Transações para obter todas as transações.

# certifique-se de ter o comando "curl" instalado \

curl -X GET https://api.asteroidetecnologia.com.br/transactions/all \
  -H 'Content-Type: application/json' \
  -H 'asteroide-key: SEU_TOKEN_AQUI' \
  -H 'asteroide-pass: SUA_SENHA_AQUI'
// certifique-se de ter a extensão php_curl instalada

$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => 'https://api.asteroidetecnologia.com.br/transactions/all',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => array(
        'Content-Type: application/json',
        'asteroide-key: SEU_TOKEN_ASTEROIDE',
        'asteroide-pass: SUA_SENHA_ASTEROIDE',
    ),
    CURLOPT_POSTFIELDS => '',
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo 'cURL Error #:' . $err;
} else {
    echo $response;
}
// No mesmo diretório do arquivo "package.json"
// npm install --save request

var request = require("request");

var options = {
  method: 'GET',
  url: 'https://api.asteroidetecnologia.com.br/transactions/all',
  headers: {
    'Content-Type': 'application/json',
    'asteroide-key': 'SEU_TOKEN_ASTEROIDE',
    'asteroide-pass': 'SUA_SENHA_ASTEROIDE'
  },
  body :  {}
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);
  console.log(body);
});

Filtrando os Resultados

Filtros permitem passar variáveis via URL e retornar as transações correspondentes ao critério.

No caso do URL do Exemplo anterior:

https://api.asteroidetecnologia.com.br/transactions/all

se você desejar utilizar filtros, você deve adicionar ? e passar cada filtro no formato:

filtro=valor

Caso deseje passar mais de um, utilize & entre cada par filtro=valor

Por exemplo.:

https://api.asteroidetecnologia.com.br/transactions/all?data_pedido_ini=2019-01-01&data_pedido_fim=2019-01-31

Para filtrar os resultados é possível utilizar os parâmetros:

Tabela 02 - Parâmetros filtro de busca
Parâmetro Padrão Descrição
guid null O identificador da venda. Ex. venda.5c3f7cfc652011.12070952
numero null O identificador utilizado para criar a transação
documento null O comprador.documento utilizado para criar a transação
nome null O comprador.nome utilizado para criar a transação
tid null O TID retornado na transação de cartão
linha_digitavel null A linha digitável retornada na transação de boleto
data_pedido_ini null A data a partir da qual se deseja obter. Formato: DD/MM/AAAA. Ex.: 2019-01-01
data_pedido_fim null A data até a qual se deseja obter. Formato: DD/MM/AAAA. Ex.: 2019-01-31
status null O status da transação. Possíveis status são:
A - Aguardando Pagamento
P - Paga
N - Negada
E - Estornada
D - Divergente
C - Cancelada
tipo_transacao null O tipo de transação. Possíveis tipos são:
boleto - Boleto
credit - Cartão de Crédito
debit - Cartão de Débito
itens_por_pagina 10 Quantidade de itens que deseja retornar por página: Ex: 10, 15, 25, 50, 100, 250, 500.
O valor máximo é 1000

Retorno JSON - Sucesso

No caso de sucesso você deverá ver algo como no JSON a seguir.

{
  "http_status": 200,
  "body": {
    "total_vendas": 25,
    "itens_por_pagina": 10,
    "vendas": [
      {
        "guid": "venda.5c3f7cfc652011.12070952",
        "identificador": "99999",
        "valor_total": "100.00",
        "tipo": "Cartão de Crédito",
        "qtd_parcelas": 1,
        "status_transacao": "P",
        "status_transacao_label": "Pago",
        "adquirente": "REDE",
        "comprador": {
          "guid": "comprador.5c3f7cfc652011.12070952",
          "nome": "John Doe",
          "documento": "01234567899",
          "tipo_documento": "CPF"
        },
        "empresa": {
          "guid": "dsdsds-ewewew-sdsdsds-dsdsds",
          "nome": "ASTEROIDE PRODUCAO"
        },
        "data_transacao": "16/01/2019 16:50:36",
        "data_pagamento": "16/01/2019",
        "data_vencimento": "26/01/2019",
        "custos": "2.49"
      },
      {
        "... estrutura igual o anterior"
      },
      "... demais 23 transações estrutura iguais anterior"
    ]
  }
}