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

# Informações Gerais

> Entenda os conceitos gerais, códigos de resposta e sobre a autenticação da API.

### URL Base

A API da Kiwify é construída com base nos princípios REST. Exigimos HTTPS em todas as requisições para melhorar a segurança, integridade e privacidade dos dados. A API não suporta requisições HTTP.

Todas as requisições devem usar a seguinte URL base:

```
https://public-api.kiwify.com
```

### Autenticação

Implementamos autenticação OAuth em nossas rotas de API, o que significa que você precisará gerar um  `bearer token` com a `api_key` usando a rota [/oauth/token](/api-reference/auth/oauth).

Para gerar o token, será necessário o  `client_secret`.

Observação: Guarde o client\_secret em um local seguro, pois ele pode ser usado para chamar todos os nossos outros endpoints da API. Ele expira em `96 horas`. Não o gere toda vez antes de chamar um endpoint.

#### Onde obter o client\_secret

1. Crie uma nova API Key na dashboard.

Clique em Apps > API > Criar API Key

<img src="https://mintcdn.com/kiwify-81/eqGeDYA02A7icNcw/images/api.png?fit=max&auto=format&n=eqGeDYA02A7icNcw&q=85&s=4e3238cd666cf107398c38aa45acc52d" alt="api" width="1944" height="1026" data-path="images/api.png" />

2. Copie o `client_secret`.

<img src="https://mintcdn.com/kiwify-81/eqGeDYA02A7icNcw/images/api-modal3.png?fit=max&auto=format&n=eqGeDYA02A7icNcw&q=85&s=c49414456dfa2d619c73342769e00a53" alt="api" width="914" height="800" data-path="images/api-modal3.png" />

### Endpoints

Para realizar a autenticação em todos os endpoints, você precisará adicionar um Authorization header e o conteúdo da header será `Bearer XXXXXXX` onde  `XXXXXXX` é o OAuth token gerado.

Você precisará também passar o `account_id`, que você pode copiar na dashboard, no mesmo local que gerou a API Key.

```
Authorization: Bearer 1234......
x-kiwify-account-id: XXXXXX
```

#### Códigos de Resposta HTTP

A API da Kiwify utiliza o padrão de códigos de resposta HTTP para indicar o sucesso ou falha de cada requisição.

No geral, códigos no intervalo 2xx demonstram sucesso, códigos 4xx indicam que ocorreu um erro no lado do cliente e códigos 5xx sugerem um problema na infraestrutura da API da Kiwify.

| Status | Descrição                                                |
| ------ | -------------------------------------------------------- |
| `200`  | Código de sucesso.                                       |
| `400`  | Erro no lado do cliente. Confira os parâmetros enviados. |
| `500`  | Erro no lado do servidor.                                |
| `429`  | O limite de requisições foi atingido.                    |

#### Rate limit

O número máximo de requisições que um usuário pode realizar é de 100 chamadas por minuto.

Ao ultrapassar esse limite, você receberá uma mensagem de erro com status code `429`.

#### FAQ

<Accordion title="Qual é o formato das datas?">
  Todas as datas serão passadas no formato `ISO 8601`: 2020-07-10 15:00:00.000
</Accordion>

<Accordion title="Qual é o formato das respostas da API?">
  As respostas da API seguem o formato JSON.
</Accordion>

<Accordion title="Existe algum limite de taxa (rate limit) para as solicitações?">
  Sim, os usuários estão limitados a 100 chamadas por minuto. Se esse limite for ultrapassado, a API retornará uma mensagem de erro com status code 429.
</Accordion>

<Accordion title="Como lidar com erros no lado do servidor (código de resposta 500)?">
  Entre em contato através do e-mail [infoprodutores@kiwify.com.br](mailto:infoprodutores@kiwify.com.br).
</Accordion>