Iniciante

Guia Rápido

Aprenda a executar sua primeira automação via API em poucos passos.

1. Como gerar API Key

Primeiro, você precisa de uma API Key para autenticar suas chamadas:

Acesse o dashboard da sua organização
Navegue até a seção "API Keys"
Clique em "Nova API Key"
Dê um nome descritivo (ex: "Integração Produção")
Copie e guarde a chave em local seguro

⚠️ Importante: A API Key é exibida apenas uma vez. Guarde-a em local seguro e nunca a compartilhe publicamente.

2. Configurar Webhook (Recomendado)

Configure webhooks para ser notificado automaticamente quando a execução finalizar:

Exemplo de payload que você receberá:

{
  "id": "DPD9oUHTmpV8dIsLrORO",
  "deliveryDate": "2025-09-09T01:32:05.356711+00:00",
  "run": {
    "id": "iuCFO7yUk2pyAsMFPKyI",
    "runMode": "bot",
    "requestedBy": "gta_pMu************************************kUCY",
    "startedAt": "2025-09-09T01:31:14.040000+00:00",
    "status": "succeeded",
    "attempts": 1,
    "errorMessage": null
  }
}

🚀 Melhor prática: Use webhooks em vez de fazer polling no endpoint de status. Isso é mais eficiente e evita limitações de rate limit.

3. Executar sua primeira automação

Com a API Key em mãos, webhook configurado e uma automação já criada no dashboard, você pode executá-la via API:

Informações necessárias:

• Organization ID: encontre no dashboard
• Site ID: disponível na listagem de sites
• Automation ID: disponível na página do site

Exemplo de chamada:

curl --location --request POST \
  'https://api.getno.com.br/v1/organizations/SEU_ORG_ID/sites/SEU_SITE_ID/automations/SEU_AUTOMATION_ID/runs' \
  --header 'x-api-key: SUA_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "inputParameters": {
      "parametro1": "valor1",
      "parametro2": "valor2"
    }
  }'

💡 Parâmetros opcionais: Inclua inputParameters apenas se a automação define parâmetros de entrada.

4. Obter resultado da execução

Após receber o webhook com status: "succeeded", obtenha o resultado:

curl --location \
  'https://api.getno.com.br/v1/organizations/SEU_ORG_ID/sites/SEU_SITE_ID/automations/SEU_AUTOMATION_ID/runs/RUN_ID/result' \
  --header 'x-api-key: SUA_API_KEY'

Resultado: Arquivo

{
  "url": "https://storage.googleapis.com/...",
  "originalName": "dados.csv",
  "expiresAt": "2025-09-14T01:26:30.264Z",
  "expiresInSeconds": 432000
}

Resultado: JSON

{
  "nome": "João Silva",
  "email": "joao@example.com",
  "produtos": [
    { "id": 1, "nome": "Produto A" }
  ]
}

⚠️ Avisos Críticos

🔐 Segurança da API Key: Trate como segredo. Nunca exponha em repositórios públicos ou clientes frontend.

📦 Arquivos .zst: Todos os arquivos são comprimidos em formato Zstandard. Descompacte localmente.

⏰ Expiração: Resultados expiram em 5 dias. Baixe e persista em seu armazenamento.

🚫 Anti-polling: Evite fazer chamadas repetidas para verificar status. Use webhooks.

🚀 Próximos Passos

Agora que você executou sua primeira automação, explore mais recursos:

Documentação