Exportar dados da base

curl --request POST \
  --url https://api.malga.io/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>' \
  --data '
{
  "$ref": "#/components/examples/ExportDataRequest"
}
'

import requests

url = "https://api.malga.io/v1/reports"

payload = { "$ref": "#/components/examples/ExportDataRequest" }
headers = {
    "X-Client-Id": "<api-key>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<api-key>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({$ref: '#/components/examples/ExportDataRequest'})
};

fetch('https://api.malga.io/v1/reports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.malga.io/v1/reports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$ref' => '#/components/examples/ExportDataRequest'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>",
    "X-Client-Id: <api-key>"
  ],
]);

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

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.malga.io/v1/reports"

	payload := strings.NewReader("{\n  \"$ref\": \"#/components/examples/ExportDataRequest\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.malga.io/v1/reports")
  .header("X-Client-Id", "<api-key>")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"$ref\": \"#/components/examples/ExportDataRequest\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.malga.io/v1/reports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"$ref\": \"#/components/examples/ExportDataRequest\"\n}"

response = http.request(request)
puts response.read_body

{
  "$ref": "#/components/examples/ExportDataPendingResponse"
}

{
  "error": {
    "type": "api_error",
    "message": "<string>",
    "details": "<array>"
  }
}

{
  "error": {
    "type": "api_error",
    "message": "<string>",
    "details": "<array>"
  }
}

POST

reports

Exportar dados da base

curl --request POST \
  --url https://api.malga.io/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>' \
  --data '
{
  "$ref": "#/components/examples/ExportDataRequest"
}
'

import requests

url = "https://api.malga.io/v1/reports"

payload = { "$ref": "#/components/examples/ExportDataRequest" }
headers = {
    "X-Client-Id": "<api-key>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-Id': '<api-key>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({$ref: '#/components/examples/ExportDataRequest'})
};

fetch('https://api.malga.io/v1/reports', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.malga.io/v1/reports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '$ref' => '#/components/examples/ExportDataRequest'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>",
    "X-Client-Id: <api-key>"
  ],
]);

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

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.malga.io/v1/reports"

	payload := strings.NewReader("{\n  \"$ref\": \"#/components/examples/ExportDataRequest\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-Id", "<api-key>")
	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.malga.io/v1/reports")
  .header("X-Client-Id", "<api-key>")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"$ref\": \"#/components/examples/ExportDataRequest\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.malga.io/v1/reports")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"$ref\": \"#/components/examples/ExportDataRequest\"\n}"

response = http.request(request)
puts response.read_body

{
  "$ref": "#/components/examples/ExportDataPendingResponse"
}

{
  "error": {
    "type": "api_error",
    "message": "<string>",
    "details": "<array>"
  }
}

{
  "error": {
    "type": "api_error",
    "message": "<string>",
    "details": "<array>"
  }
}

Authorizations

X-Client-Id

string

header

required

X-Api-Key

string

header

required

Headers

accept-language

enum<string>

default:en

Idioma da exportação

Available options:

en,

pt

X-User-Timezone

string

default:America/Sao_Paulo

Timezone local do cliente no formato tz database

Body

application/json

Relatório Simples
Relatório completo

Possuí somente o ultimo status de transação

sendTo

string

required

E-mail para qual a exportação será enviada

type

enum<string>

required

Tipo de relatório

Available options:

transactions

fields

required

Exportando todos os campos

Available options:

all

filters

object

required

Filtros que serão aplicados aos dados para a exportação

Show child attributes

Response

Created

string

Id da exportação

clientId

string

Identificador do cliente na Malga

string

E-mail para qual a exportação foi enviada

language

enum<string>

Idioma usado na exportação

Available options:

pt,

en

type

enum<string>

Tipo de relatório

Available options:

transactions,

transactionsHistory

status

array

pagesCount

number

Número de arquivos gerados

files

array

Lista do nome dos arquivos gerados

fields

enum<string>[]

Lista de filtros que foram exportados

Available options:

card_brand__brand,

card__holder_name,

customer__client_id,

customer__name,

customer__email,

customer__phone_number,

customer__document_number,

customer__customer_adress_id,

customer_address__complement,

customer_address__zip_code,

customer_address__street,

customer_address__street_number,

customer_address__state,

customer_address__city,

customer_address__district,

customer_address__country,

nupay__payment_type,

transaction__id,

transaction__amount,

transaction__original_amount,

transaction__created_at,

transaction__currency,

transaction__description,

transaction__order_id,

transaction__merchant_id,

transaction_request__created_at,

transaction_request__payment_method,

transaction_request__provider_id,

transaction__installments,

transaction__status,

transaction_source__card_id,

transaction__statement_descriptor,

provider__name,

session__id

createdAt

string<2023-04-01T00:00:00Z>

Data da criação

updatedAt

string<2023-04-01T00:01:00Z>

Data da atualização

expiredAt

string<2023-05-01T00:00:00Z>

Data de expiração dos links para download dos arquivos

timezone

string<America/Sao_Paulo>

Timezone utilizado para as datas

filters

object

Filtros que foram aplicados aos dados para a exportação

Show child attributes

Visão Geral

Client-token

Cards

Tokens

Charges

Sessions

Customers

Merchants

Vendors

Sellers

Flows

Webhooks

Reports

Exportar dados da base

Authorizations

Headers

Body

Response