Início / Documentação

Documentação da API

Com a API REST, um script ou uma planilha lê os seus quizzes, ofertas, páginas, funis e os leads capturados. Por enquanto a API só lê: criar, editar e publicar continuam pelo app.

Por onde começar

API RESTEndpoints, parâmetros e respostas reais, com exemplos em curl e JavaScript. Formato dos documentosEtapas de quiz, blocos, camadas de página e funis. Criar uma chaveAbra o app, vá em API na barra lateral e crie a sua chave. Limites e errosQuantos pedidos por minuto, o tamanho das páginas de leads e o que cada erro quer dizer.

Quem pode usar

A API faz parte dos planos Pro e Scale. Durante os 7 dias de teste do Pro, a conta nova também pode usar. Quando a conta volta para um plano sem API, as chaves continuam guardadas, mas todo pedido responde com status 402 e motivo api até a conta mudar de plano.

Chaves

No app, abra API na barra lateral. Dê um nome à chave e clique em Criar chave. A chave aparece uma vez só, no formato clx_ seguido de 32 caracteres. Copie e guarde num lugar seguro. Se perder, revogue e crie outra.

Toda chave só lê: lista e lê documentos, leads, modelos e o catálogo de blocos, sem mudar nada na conta.

A chave vale para o workspace em que foi criada. Revogar corta o acesso na hora e não dá para desfazer. A tabela de chaves mostra o último uso de cada uma.

Autenticação

Mande a chave no cabeçalho Authorization de todo pedido:

Authorization: Bearer clx_SUA_CHAVE

A chave vale como senha: nunca coloque num site público nem num repositório.

Primeiro teste

curl -H "Authorization: Bearer clx_SUA_CHAVE" "https://cloonyx.com/api/v1/documents?type=pages"

Tipos de documento

Cada rota de documento recebe o tipo em type. Ao ler, content traz o rascunho atual, e publicUrl o endereço da versão no ar.

Tipo	Valor de type	Endereço público
Quiz	`quizzes`	`/q/slug`
Oferta	`offers`	`/o/slug`
Página	`pages`	`/p/slug`
Funil	`funnels`	Não vai ao ar sozinho. Publique cada quiz, oferta ou página do funil.

Limites

Limite	Valor
Pedidos por chave	120 por minuto. Passou disso, a resposta é 429 até o minuto virar.
Tamanho do corpo do pedido	20 MB
Leads por página	50 por padrão, até 200 com o parâmetro limit
Nome da chave	Até 80 caracteres

Erros

Todo erro volta em JSON com uma mensagem em português em error e, quase sempre, um código estável em motivo para o seu código decidir o que fazer. Quando há mais de um problema, a lista completa vem em detalhes.

{
  "error": "Use type igual a quizzes, offers, pages ou funnels.",
  "motivo": "tipo_invalido"
}

Status	motivo	Quando acontece
401	`sem_chave`	O pedido veio sem o cabeçalho Authorization.
401	`chave_invalida`	A chave não existe, foi revogada ou não vale para este workspace.
402	`api`	A conta está num plano sem API.
403	`somente_leitura`	O pedido tenta criar, editar, publicar ou aplicar modelo. Por enquanto a API só lê.
400	`tipo_invalido`	O type não é quizzes, offers, pages ou funnels.
400	`data_invalida`	O parâmetro since não é uma data ISO.
400	`cursor_invalido`	O cursor de leads não veio de uma resposta anterior.
404	`nao_encontrado`	Documento, modelo ou tipo de bloco não existe.
404	`rota_desconhecida`	O caminho não é uma rota da API.
429	sem motivo	Passou de 120 pedidos por minuto com a mesma chave.

PróximoAPI REST