Entendendo Malga API SDK

Nessa seção você poderá compreender como configurar o API SDK, acessar as especificações detalhadas de cada método, além de entender como usar a Chave de Idempotência e fazer o tratamento de erros corretamente.

Configuração

Configurar o Malga API SDK é simples, inicialmente você precisará das credênciais que são o API Key, Client ID e Merchant ID. Se você ainda não tem uma conta Malga basta clicar aqui e criar uma conta em nosso Dashboard e você terá acesso as credênciais para iniciar sua integração.

Agora que vocês já está com as chaves de acesso, você só precisará baixar o pacote no seu projeto importa o pacote no seu arquivo e usar o seguinte código:

Node.js

import { Malga } from "malga";

const malga = new Malga({
  apiKey: "17a64c8f-a387-4682-bdd8-d280493715e0",
  clientId: "d1d2b51a-0446-432a-b055-034518c2660e",
  options: {
    sandbox: true,
    http: {
      retries: 3,
      retryDelay: 10000,
    },
  },
});

Abaixo está a lista detalhada com todos os parâmetros de configuração disponíveis.

Show Parâmetros de Configuração

apiKey · uuid · required

Chave de acesso a API

clientId · uuid · required

Identificador único da sua conta na Malga

options · object

Configurações adicionais

Show Parâmetros de options

sandbox · string

Define se integração está rodando no ambiente de teste ou produção

http · object

Configurações das requisições http

Show Parâmetros de http

retries · number

Número de retentativa de uma requisição em caso de falha para evitar condições de corrida

retryDelay · number

Tempo entre uma retentativa e outra em milisegundos

Chave de Idempotência

O Malga API SDK suporta chaves de idempotência para evitar duplicidade no processamento de requisições no caso de retentativas de uma mesma operação. Para que isso seja possível, cada um dos nossos métodos de criação suporta uma parâmetro adicional chamado idempotencyKey para que seja definida a chave de idempotência.

Abaixo está um exemplo de como utilizar:

Node

import { Malga } from "malga";

const malga = new Malga({
  apiKey: "17a64c8f-a387-4682-bdd8-d280493715e0",
  clientId: "d1d2b51a-0446-432a-b055-034518c2660e",
});

await malga.charges.create(
  {
    merchantId: "8cfef0d1-73af-4bdb-b6c4-09ad3fbfc7f1",
    amount: 100,
    paymentMethod: {
      type: "credit",
      installments: 1,
      card: {
        holderName: "João da Silva",
        number: "5453881028277600",
        cvv: "170",
        expirationDate: "10/2030",
      },
    },
  },
  { idempotencyKey: "518eb962-cccd-4bc3-a497-4e48335dc8c4" }
);

Basta clicar aqui para saber mais detalhes sobre a chave de idempotência.

Tratamento de Erros

No Malga API SDK o tratamento de erros é padronizado, todos os erros são retornados da mesma forma com uma estrutura unificada. Dessa forma damos mais previsibilidade de como é o comportamento dos métodos.

Abaixo está a estrutura detalhada de como é retorno dos erros.

Show Tratamento de Erros

error · object

Objeto com os detalhes do erro

Show Parâmetros do error

type · string

Tipo do erro

code · number

Status code da requisição

message · string

Mensagem resumida do erro

details · string | array

Mensagem detalhada do erro contendo os campos

declinedCode · string | array

Códigos de negação repassado pelo provedor

Basta clicar aqui para saber mais detalhes sobre o nosso tratamento de erros.