> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assiny.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução à API pública

> Cadastre produtos, ofertas e funis e consulte vendas, assinaturas e reembolsos a partir do seu próprio sistema

A API pública dá ao seu sistema acesso aos dados e às ações do painel da Assiny, sem precisar entrar no painel. Toda chamada usa uma **chave de API da sua organização**, e cada chave só acessa os projetos liberados para ela.

> [card] Catálogo
>
> Criar e editar produtos e ofertas, um por vez ou em lote, e criar funis para receber o link do checkout.

> [card] Operação
>
> Listar vendas com filtros, ver o detalhe de cada uma, administrar assinaturas e parcelamentos e responder a pedidos de reembolso.

## Antes de começar

Você vai precisar de três coisas.

**Uma chave de API da sua organização.** Ela é gerada pela equipe da Assiny e enviada a você **uma única vez**. Peça a sua pelo suporte, dizendo quais projetos a chave deve acessar.

**O ID do projeto** (UUID) de cada projeto que você vai usar. Ele aparece no endereço do painel, depois de `/projects/`.

**Um servidor para fazer as chamadas.** A chave dá acesso aos dados de venda e de compradores, então ela nunca deve ir para o navegador, o app ou um repositório de código.

> [!WARNING]
>
> **A guarda da chave é responsabilidade sua.** Trate a chave como uma senha: a Assiny não consegue mostrar a mesma chave de novo e não se responsabiliza pelo uso de uma chave que vazar do seu lado. Se suspeitar de vazamento, peça ao suporte para revogá-la na mesma hora e gerar outra — a chave revogada para de funcionar imediatamente.

## Endereço base

Todos os caminhos ficam depois de:

```
https://bff.assiny.com.br/v1/public
```

## Rotas disponíveis

### Catálogo

| Método | Caminho | O que faz |
| - | - | - |
| `GET` | `/product/list/product/checkout/{projectId}` | [Lista os produtos do projeto com as ofertas](https://docs.assiny.com/api/produtos.md) |
| `POST` | `/product` | [Cria um produto](https://docs.assiny.com/api/produtos.md) |
| `POST` | `/multiple-products` | [Cria vários produtos](https://docs.assiny.com/api/produtos.md) |
| `POST` | `/product/{productId}` | [Edita um produto](https://docs.assiny.com/api/produtos.md) |
| `POST` | `/checkout` | [Cria uma oferta](https://docs.assiny.com/api/ofertas.md) |
| `POST` | `/multiple-checkouts` | [Cria várias ofertas](https://docs.assiny.com/api/ofertas.md) |
| `POST` | `/checkout/{offerId}` | [Edita uma oferta](https://docs.assiny.com/api/ofertas.md) |
| `POST` | `/funnel` | [Cria um funil](https://docs.assiny.com/api/funis.md) |
| `POST` | `/multiple-funnels` | [Cria vários funis](https://docs.assiny.com/api/funis.md) |

### Operação

| Método | Caminho | O que faz |
| - | - | - |
| `GET` | `/financial/bff/project/transaction` | [Lista as vendas do projeto](https://docs.assiny.com/api/vendas.md) |
| `GET` | `/financial/bff/sale/details/{transactionId}` | [Detalhe de uma venda](https://docs.assiny.com/api/vendas.md) |
| `GET` | `/subscription-admin/subscription/details/{subscriptionId}` | [Detalhe de uma assinatura](https://docs.assiny.com/api/assinaturas.md) |
| `PATCH` | `/subscription-admin/cancel/subscription/{subscriptionId}` | [Cancela uma assinatura](https://docs.assiny.com/api/assinaturas.md) |
| `POST` | `/subscription-admin/reactivate/charge/{subscriptionId}` | [Reativa as cobranças de uma assinatura](https://docs.assiny.com/api/assinaturas.md) |
| `POST` | `/smart-installment-admin/reactivate/charge/{installmentId}` | [Reativa as cobranças de um parcelamento](https://docs.assiny.com/api/assinaturas.md) |
| `POST` | `/request-refund/send-request` | [Responde a um pedido de reembolso](https://docs.assiny.com/api/reembolsos.md) |

## Por onde seguir

> [card] [Autenticação](https://docs.assiny.com/api/autenticacao.md)
>
> Os cabeçalhos de toda chamada e onde vai o projeto

> [card] [Primeira chamada](https://docs.assiny.com/api/primeira-chamada.md)
>
> Testar a chave no Postman ou pelo terminal

> [card] [Erros](https://docs.assiny.com/api/erros.md)
>
> O formato do erro e o que fazer em cada status

> [card] [Usar com IA](https://docs.assiny.com/api/usar-com-ia.md)
>
> O texto para colar no seu assistente de código

Para receber um aviso a cada evento, em vez de consultar, veja [Introdução aos webhooks](https://docs.assiny.com/webhooks/introducao.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.