Nucleo Icon
NUCLEO CLONE

Documentação da API

Integre o poder de clonagem do Nucleo em suas próprias aplicações.

NOVO Autenticação

Para usar o endpoint de clonagem, você precisa de uma chave de API. A chave deve ser enviada no cabeçalho X-API-Key de suas requisições.

Você tem direito a 3 clonagens gratuitas. Após atingir o limite, será necessário realizar um pagamento via PIX para continuar utilizando a API.

POST /api/generate-key

Gera uma nova chave de API para autenticação. Use um dos exemplos abaixo para gerar sua chave. Guarde-a em um local seguro, pois ela não será exibida novamente.

Resposta de Sucesso (200)

{ "apiKey": "nc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "message": "Please save this key securely. It will not be shown again." }

POST /api/clone

Inicia um novo processo de clonagem para a URL especificada. Requer autenticação via chave de API.

Cabeçalhos (Headers)

X-API-Key - Sua chave de API gerada.

Parâmetros (Body)

{ "url": "https://exemplo.com" }

Resposta de Sucesso (200)

{ "task_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef" }

Respostas de Erro

Chave não enviada (401 Unauthorized):

{ "error": "API Key is missing." }

Chave inválida (403 Forbidden):

{ "error": "Invalid API Key." }

Limite de uso atingido (402 Payment Required):

{ "error": "Payment Required: You have reached the free limit of 3 clones.", "paymentInfo": { "message": "Limite gratuito atingido. Pague via PIX para continuar clonando.", "amount": 9.99, "currency": "BRL", "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...", "copyPaste": "00020126580014BR.GOV.BCB.PIX0136123e4567-e89b-12d3-a456-426614174000..." } }

GET /api/status/:taskId

Verifica o status de uma tarefa de clonagem em andamento.

Parâmetros (URL)

:taskId - O ID da tarefa retornado pelo endpoint /api/clone.

Resposta de Sucesso (200)

{ "task_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef", "status": "processing" | "completed" | "failed" | "pending", "error": "Mensagem de erro (se houver)" }

GET /api/download/:taskId

Faz o download do arquivo .zip contendo o site clonado.

Parâmetros (URL)

:taskId - O ID da tarefa concluída.

Resposta de Sucesso (200)

A resposta será um arquivo .zip para download.