> ## Documentation Index
> Fetch the complete documentation index at: https://malga-develop.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Sobre as APIs

export const LinkToDownload = ({url, message, fileName}) => {
  if (typeof document === "undefined") return null;
  setTimeout(async () => {
    const link = document.getElementsByClassName('openapi')[0];
    const blob = await fetch(url).then(res => res.blob());
    const objectURL = URL.createObjectURL(blob);
    link.href = objectURL;
    link.download = fileName;
  }, 1);
  return <a className="openapi">{message}</a>;
};

A Malga oferece uma API completa para integração de pagamentos. A autenticação é feita via headers HTTP para todas as chamadas da API. É necessário informar o identificador do cliente (`X-Client-Id`) e a chave secreta de acesso (`X-Api-Key`) em cada requisição. [Clique aqui](/api-reference/authentication) e leia nossa documentação sobre a autenticação.

<br />

<LinkToDownload url="https://malga-docs-prod.s3.amazonaws.com/files/openapi.json" message="Faça download da nossa especificação da OpenAPI" fileName="openapi.json" /> e tenha acesso ao conjunto de ferramentas para desenvolvimento que facilitarão a integração.

## Configurações da API

A nossa API oferece endpoints para diversas funcionalidades, comece a estruturar sua integração com a Malga explorando as páginas abaixo.

### Chaves para autenticação

<Card title="Client-token" icon="key" href="/api-reference/client-token">
  Crie chaves públicas de acesso temporário a API com escopo e tempo de
  expiração limitados. Recomendamos o uso deste tipo de chave quando você tiver
  que expor a chave em uma aplicação client side
</Card>

### Cartões

<CardGroup cols={2}>
  <Card title="Tokens" icon="shield" href="/api-reference/tokens/">
    Utilize o serviço de Tokenização para coletar os dados de cartão dos seus clientes, sem que informações sensíveis trafeguem no seu servidor. Através dos tokens, você processa pagamentos de forma segura, atendendo às normas PCI
  </Card>

  <Card title="Cards" icon="credit-card" href="/api-reference/cards/">
    Crie e armazene cartões dos seus clientes com segurança para realizar novas cobranças
  </Card>
</CardGroup>

### Pagamentos

<CardGroup cols={2}>
  <Card title="Charges" icon="cash-register" href="/api-reference/charges/">
    Crie cobranças com os métodos de pagamento disponíveis na Malga. É possível recuperar detalhes de transações individuais ou listá-las a partir do seu `X-Client-Id`;
  </Card>

  <Card title="Sessions" icon="window-restore" href="/api-reference/sessions/">
    Crie sessões para gerar pedidos com itens, com métodos de pagamento e outros atributos associados, que pode ser pago através da nossa API, pelo Link de Pagamento ou integrado ao nosso Malga Checkout/Full;
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Customers" icon="user" href="/api-reference/customers/">
    Realize a criação, edição, listagem e exclusão de dados de compradores para busca de cobranças e uso nos serviços de tokenização de cartões, cobrança por PIX, Boleto, uso em análise de motores de antifraude e de recorrência;
  </Card>

  <Card title="Merchants" icon="store" href="/api-reference/merchants">
    O merchant (subconta) é a entidade que representa sua loja ou negócio na Malga e que guarda as chaves de provedores. Ele é utilizado para processar cobranças e separar operações, recebíveis e dados de cada loja ou cliente;
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Vendors" icon="clipboard-user" href="/api-reference/vendors">
    Serviço que permite que facilitadores habilitem estabelecimentos comerciais para aceitação de pagamentos e que os beneficiários finais das transações sejam identificados na cobrança. Este serviço deve ser utilizado por negócios que possuem essa exigência regulatória;
  </Card>

  <Card title="Sellers" icon="users" href="/api-reference/sellers">
    Realize a criação e a configuração de recebedores para transações com Split.
    Um seller é um cadastro de PF ou PJ, com regras de recebimento associadas e
    registrados nos provedores, para quem você irá repassar automaticamente
    valores de uma cobrança;
  </Card>
</CardGroup>

### Configurações

<CardGroup cols={2}>
  <Card title="Webhooks" icon="bell" href="/api-reference/webhooks/">
    Notifique o seu sistema sobre os eventos ocorridos na Malga. Através de webhooks, você consegue atualizar seu sistema sempre que um evento importante acontece
  </Card>

  <Card title="Reports" icon="file-export" href="/api-reference/reports/">
    Realize a exportação em formato .csv das informações das transações processadas através da Malga, relacionadas à cobrança, detalhes dos provedores e do cliente que realizou o pagamento
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Flows" icon="network-wired" href="/api-reference/flows/">
    Através da API Flows, você pode conferir os fluxos de pagamentos da sua loja
    ou merchant. Os fluxos inteligentes são um recurso da Malga para gestão
    flexível dos pagamentos, possibilitando a inserção de regras e condicionais
    para o processamento das cobranças
  </Card>

  <Card title="Analytics" icon="chart-simple" href="/analytics/">
    Com a API de Analytics é possível consultar dados de transações processadas,
    permitindo análises gerenciais e acompanhamento dos pagamentos
  </Card>
</CardGroup>