# Kiwify API

## API Pública

### API Reference

- [Informações Gerais](https://docs.kiwify.com.br/api-reference/general.md): Entenda os conceitos gerais, códigos de resposta e sobre a autenticação da API.

### Autenticação

- [Gerar token OAuth](https://docs.kiwify.com.br/api-reference/auth/oauth.md): Entenda como adquirir o token Bearer OAuth, necessário para autenticação nas demais rotas da API.

### Conta

- [Consultar detalhes da conta](https://docs.kiwify.com.br/api-reference/account/account-details.md)

### Produtos

- [Listar produtos](https://docs.kiwify.com.br/api-reference/products/list.md): Obtenha uma lista de todos os produtos.
- [Consultar produto](https://docs.kiwify.com.br/api-reference/products/single.md): Obtenha os detalhes de um produto específico, passando o product_id.

### Vendas

- [Listar vendas](https://docs.kiwify.com.br/api-reference/sales/list.md): Obtenha uma lista de todas as vendas. O período máximo entre o start_date e o end_date é de 90 dias..
- [Consultar venda](https://docs.kiwify.com.br/api-reference/sales/single.md): Consulte os detalhes de uma venda específica, passando o order_id.
- [Reembolsar venda](https://docs.kiwify.com.br/api-reference/sales/refund.md)
- [Consultar estatísticas de vendas](https://docs.kiwify.com.br/api-reference/sales/stats.md)

### Financeiro

#### Saldos

- [Consultar saldos](https://docs.kiwify.com.br/api-reference/finance/balance/list.md): Consulte todos os saldos da sua conta.
- [Consultar saldo específico](https://docs.kiwify.com.br/api-reference/finance/balance/single.md): Consulte um saldo específico da sua conta, passando o legal_entity_id.

#### Saques

- [Listar saques](https://docs.kiwify.com.br/api-reference/finance/payouts/list.md): Obtenha uma lista de todos os saques.
- [Consultar saque](https://docs.kiwify.com.br/api-reference/finance/payouts/single.md): Consulte detalhes de um saque específico, passando o id do saque
- [Realizar um saque](https://docs.kiwify.com.br/api-reference/finance/payouts/create.md): Solicita a realização de um saque. Exige o cabeçalho Idempotency-Key, um UUID gerado por você que identifica o saque. Este endpoint é de natureza síncrona, o que significa que você terá uma resposta imediata, porém, para saber o status da solicitação, será necessário consultar o dashboard, no menu f…

### Afiliados

- [Listar afiliados](https://docs.kiwify.com.br/api-reference/affiliates/list.md): Obtenha uma lista com todos os afiliados.
- [Consultar afiliado](https://docs.kiwify.com.br/api-reference/affiliates/single.md): Consulte os detalhes de um afiliado específico, passando o affiliate_id.
- [Editar afiliado](https://docs.kiwify.com.br/api-reference/affiliates/edit.md): Editar informações de um afiliado específico, passando o affiliate_id.

### Webhooks

- [Listar webhooks](https://docs.kiwify.com.br/api-reference/webhooks/list.md): Obtenha uma lista de todos webhooks.
- [Criar webhook](https://docs.kiwify.com.br/api-reference/webhooks/create.md)
- [Consultar webhook](https://docs.kiwify.com.br/api-reference/webhooks/single.md): Consulte detalhes de um webhook específico, passando o webhook_id.
- [Atualizar webhook](https://docs.kiwify.com.br/api-reference/webhooks/edit.md): Atualize um webhook específico, passando o webhook_id.
- [Deletar webhook](https://docs.kiwify.com.br/api-reference/webhooks/delete.md): Delete um webhook específico, passando o webhook_id.

### Eventos

- [Listar participantes](https://docs.kiwify.com.br/api-reference/events/list.md)

## Área de Membros

### Introdução

- [Personalização da Área de Membros](https://docs.kiwify.com.br/members-area/general.md): Um guia completo para criar experiências personalizadas de membros com Temas Kiwify

### Conceitos Principais

- [Estrutura do Tema](https://docs.kiwify.com.br/members-area/key-concepts/theme-architecture.md): Entendendo a arquitetura e os componentes
- [Tema Padrão](https://docs.kiwify.com.br/members-area/key-concepts/the-default-theme.md): Conhecendo o tema padrão e suas partes

#### Tema

- [Templates](https://docs.kiwify.com.br/members-area/key-concepts/theme/templates.md): Arquivos JSON que definem a estrutura e conteúdo da página
- [Seções](https://docs.kiwify.com.br/members-area/key-concepts/theme/sections.md): Componentes liquid reutilizáveis para conteúdo da página
- [Locales](https://docs.kiwify.com.br/members-area/key-concepts/theme/locales.md): Arquivos de tradução para múltiplos idiomas
- [Snippets](https://docs.kiwify.com.br/members-area/key-concepts/theme/snippets.md): Fragmentos de código reutilizáveis compartilhados entre seções

### Referências

#### Objetos

- [Visão Geral](https://docs.kiwify.com.br/members-area/reference/objects.md): Entenda os objetos disponíveis dentro da Área de Membros
- [all_courses](https://docs.kiwify.com.br/members-area/reference/objects/all_courses.md): O objeto all_courses contém todos os cursos adicionados ao seu clube.
- [all_courses_values](https://docs.kiwify.com.br/members-area/reference/objects/all_courses_values.md): A lista all_courses_values contém todos os cursos adicionados ao seu clube.
- [all_modules](https://docs.kiwify.com.br/members-area/reference/objects/all_modules.md): O objeto all_modules contém todos os módulos adicionados ao seu clube.
- [all_lessons](https://docs.kiwify.com.br/members-area/reference/objects/all_lessons.md): O objeto all_lessons contém todas as aulas adicionadas ao seu clube.
- [club](https://docs.kiwify.com.br/members-area/reference/objects/club.md): O objeto club contém informações sobre a área de membros.
- [is_preview](https://docs.kiwify.com.br/members-area/reference/objects/is_preview.md): A flag is_preview indica se o template está sendo renderizado dentro do editor ou não.
- [last_watched_lessons](https://docs.kiwify.com.br/members-area/reference/objects/last_watched_lessons.md): A lista last_watched_lessons contém o ID das últimas aulas assistidas pelo usuário atual, ordenadas por mais recente
- [section](https://docs.kiwify.com.br/members-area/reference/objects/section.md): As propriedades e configurações de uma seção.
- [source](https://docs.kiwify.com.br/members-area/reference/objects/source.md): A string source indica dentro de qual editor o template está sendo renderizado.
- [course](https://docs.kiwify.com.br/members-area/reference/objects/course.md): O objeto course contém informações sobre um curso específico no seu clube.
- [module](https://docs.kiwify.com.br/members-area/reference/objects/module.md): O objeto module contém informações sobre um módulo específico dentro de um curso.
- [lesson](https://docs.kiwify.com.br/members-area/reference/objects/lesson.md): O objeto lesson contém informações sobre uma aula específica dentro de um módulo.
- [user_data](https://docs.kiwify.com.br/members-area/reference/objects/user_data.md): O objeto user_data contém informações sobre a interação de um usuário com cursos e módulos.
- [lesson_user_data](https://docs.kiwify.com.br/members-area/reference/objects/lesson_user_data.md): O objeto lesson_user_data contém informações sobre a interação de um usuário com aulas.
- [custom_offer](https://docs.kiwify.com.br/members-area/reference/objects/custom_offer.md): O objeto custom_offer contém informações sobre se um curso, módulo ou aula pode ser comprado dentro da área de membros.
- [block](https://docs.kiwify.com.br/members-area/reference/objects/block.md): O conteúdo e configurações de um bloco de seção.

#### Linguagem Liquid

- [Visão Geral](https://docs.kiwify.com.br/members-area/reference/liquid-language.md): Liquid é um engine de template que permite criar páginas web dinâmicas.

##### Tags

- [Visão Geral](https://docs.kiwify.com.br/members-area/reference/tags.md): Entenda as tags liquid disponíveis
- [Tags de variável](https://docs.kiwify.com.br/members-area/reference/tags/variable.md): Tags de variável permitem criar novas variáveis Liquid.
- [Tags condicionais](https://docs.kiwify.com.br/members-area/reference/tags/conditional.md): Tags condicionais permitem controlar o fluxo dos seus templates.
- [Tags HTML](https://docs.kiwify.com.br/members-area/reference/tags/html.md): Tags HTML ajudam você a trabalhar com HTML nos seus templates Liquid.
- [Tags de iteração](https://docs.kiwify.com.br/members-area/reference/tags/iteration.md): Tags de iteração permitem executar blocos de código repetidamente.
- [Tags de sintaxe](https://docs.kiwify.com.br/members-area/reference/tags/syntax.md): Tags de sintaxe fornecem controle adicional sobre o código do template.
- [Tags de tema](https://docs.kiwify.com.br/members-area/reference/tags/theme.md): Tags de tema ajudam você a estruturar e organizar seus templates.

##### Filtros

- [Visão Geral](https://docs.kiwify.com.br/members-area/reference/filters.md): Filtros são usados para modificar a saída de variáveis e outros valores.
- [Filtros de array](https://docs.kiwify.com.br/members-area/reference/filters/array.md): Filtros de array para trabalhar com coleções em templates Liquid.
- [Filtros de string](https://docs.kiwify.com.br/members-area/reference/filters/string.md): Filtros de string para manipular texto em templates Liquid.
- [Filtros HTML](https://docs.kiwify.com.br/members-area/reference/filters/html.md): Filtros HTML para trabalhar com conteúdo HTML e URI em templates Liquid.
- [Filtros matemáticos](https://docs.kiwify.com.br/members-area/reference/filters/math.md): Filtros matemáticos para realizar operações aritméticas em templates Liquid.
- [Filtros de data](https://docs.kiwify.com.br/members-area/reference/filters/date.md): Filtros de data para formatar datas em templates Liquid.
- [Filtros diversos](https://docs.kiwify.com.br/members-area/reference/filters/misc.md): Filtros diversos para várias operações em templates Liquid.

#### Schema

- [Visão geral](https://docs.kiwify.com.br/members-area/reference/schema/overview.md): O schema de seção permite definir atributos e configurações de seção para personalização de tema.

##### Campos

- [Blocos](https://docs.kiwify.com.br/members-area/reference/schema/fields/blocks.md): Documentação detalhada sobre configuração de blocos de seção.
- [Presets](https://docs.kiwify.com.br/members-area/reference/schema/fields/presets.md): Documentação detalhada sobre configuração de presets de seção.
- [Restrições de Template](https://docs.kiwify.com.br/members-area/reference/schema/fields/template-restrictions.md)

##### Configurações

- [Visão geral](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings.md): Documentação detalhada sobre configuração de settings de seção.

###### Tipos de Entrada

- [Visão geral](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings/input-types/overview.md): Tipos de entrada permitem definir diferentes tipos de configurações nas suas seções de tema.
- [Checkbox](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings/input-types/checkbox.md): Documentação para o tipo de entrada checkbox em configurações de seção.
- [Curso](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings/input-types/course.md): Documentação para o tipo de entrada curso em configurações de seção.
- [Seletor de Imagem](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings/input-types/image-picker.md): Documentação para o tipo de entrada seletor de imagem em configurações de seção.
- [Módulo](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings/input-types/module.md): Documentação para o tipo de entrada módulo em configurações de seção.
- [Range](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings/input-types/range.md): Documentação para o tipo de entrada range em configurações de seção.
- [Select](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings/input-types/select.md): Documentação para o tipo de entrada select em configurações de seção.
- [Texto](https://docs.kiwify.com.br/members-area/reference/schema/fields/settings/input-types/text.md): Documentação para o tipo de entrada de texto em configurações de seção.

## OpenAPI Specs

- [openapi](/api-reference/banking/openapi.json)
- [openapi.pt](/api-reference/banking/openapi.pt.json)
- [openapi](/api-reference/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English (75 pages)](https://docs.kiwify.com.br/_llms/en.md): Documentation for English.