Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://pedirgasdocs.supergasbras.app/llms.txt

Use this file to discover all available pages before exploring further.

A Supergasbras oferece um conjunto de APIs RESTful que permitem integrar a experiência de compra de gás diretamente na sua aplicação. Com as APIs Cart, Checkout e Composition, você gerencia todo o ciclo de vida de um pedido — do carrinho ao pagamento.

APIs disponíveis

Cart API

Cria e gerencia sessões de carrinho de compras, incluindo agendamento de entrega.

Checkout API

Controla sessões de compra, cupons promocionais e pagamentos.

Composition API

Fornece ofertas recomendadas para consumidores e relatórios financeiros para revendedores.

Fluxo geral de uma compra

Um pedido típico na plataforma Supergasbras segue este fluxo:
1

Sessão de carrinho

Crie ou atualize uma sessão de carrinho via Cart API com os produtos que o cliente deseja comprar.
2

Sessão de checkout

Inicie uma sessão de compra na Checkout API. Vincule a sessão de carrinho e defina os dados do cliente.
3

Entrega e cupons

Atualize as informações de entrega e aplique eventuais cupons promocionais à sessão de compra.
4

Pagamento

Liste os métodos de pagamento disponíveis, inicie o pagamento e complete a sessão.

Ambientes

Todas as APIs utilizam HTTPS. As URLs base de produção são:
APIURL base
Cart APIhttps://cart-ms.supergasbras.app
Checkout APIhttps://checkout-ms.supergasbras.app
Composition APIhttps://composition-ms.supergasbras.app
Certifique-se de incluir seu token de autenticação em todas as requisições. Veja Autenticação para detalhes.

Próximos passos

Autenticação

Configure seu token e aprenda a autenticar as requisições.

Início Rápido

Faça sua primeira chamada de API com exemplos práticos.