Informações Gerais

​

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.

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

2. Copie o client_secret.

​

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.

​

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