# Escolha seu caminho

> Encontre a trilha certa para integrar com a API do GS Engage conforme o seu perfil: sem código, com código ou análise de dados.

- URL canônica: https://docs.growthstation.app/docs/api/comece-aqui/escolha-seu-caminho
- Idioma: pt-BR
- Última atualização: 2026-09-20T08:21:20.449Z
- Produto: GS Engage
- Mantido por: Produto GS Engage



<PageHero emoji="🧭" title="Escolha seu caminho" description="A API do GS Engage serve a gente muito diferente. Escolha a trilha que combina com o seu objetivo e com o quanto você quer (ou não) programar." gradient="brand" />

A **API** do GS Engage é a ponte que deixa outros sistemas conversarem com a sua operação de vendas: criar leads, acompanhar prospecções, extrair dados e receber avisos automáticos. Só que cada pessoa chega aqui com uma meta e um repertório diferentes.

Para você não se perder, dividimos a jornada em três trilhas. Leia as descrições abaixo, identifique com qual perfil você mais se parece e siga o caminho indicado.

<Callout type="tip" title="Não sabe programar? Sem problema.">
  Você não precisa escrever código para integrar com o GS Engage. A trilha **Sem código** usa ferramentas visuais de arrastar e soltar. Comece por ali sem medo.
</Callout>

🗺️ As três trilhas [#️-as-três-trilhas]

<CardGrid cols={3}>
  <CardLink href="/docs/api/no-code/zapier" icon="🧩" title="Sem código" badge="Marina">
    Conecte o GS Engage a outras ferramentas usando Zapier, Make ou n8n — sem escrever uma linha de código.
  </CardLink>

  <CardLink href="/docs/api/comece-aqui/quickstart" icon="💻" title="Com código" badge="Bruno">
    Faça sua primeira chamada, siga os guias e consulte a referência completa dos endpoints.
  </CardLink>

  <CardLink href="/docs/api/guias/extrair-para-dashboard" icon="📊" title="Análise de dados" badge="Rafael">
    Extraia informações de prospecções e leads para montar dashboards e entender os status.
  </CardLink>
</CardGrid>

🧩 Trilha Sem Código — para quem não programa [#-trilha-sem-código--para-quem-não-programa]

Essa trilha é para a **Marina**: ela cuida de marketing e operações, entende do negócio, mas não escreve código. O objetivo dela é ligar o GS Engage a outras ferramentas que já usa — planilhas, CRMs, e-mail — de forma automática.

O GS Engage tem integração nativa com o **Zapier** (inclusive gatilhos de webhook, que são avisos automáticos disparados quando algo acontece). O **Make** e o **n8n** também conseguem consumir a API e receber esses avisos. Tudo isso em telas visuais de arrastar e conectar.

<FieldInfoGroup>
  <FieldInfo title="É a sua trilha se...">
    Você quer automatizar tarefas (por exemplo, criar um lead no GS Engage quando alguém preenche um formulário) sem depender de um desenvolvedor.
  </FieldInfo>

  <FieldInfo title="O que você vai fazer">
    Conectar aplicativos, escolher gatilhos e ações em ferramentas como Zapier, Make e n8n, e testar a automação clicando em botões.
  </FieldInfo>
</FieldInfoGroup>

<CardGrid cols={1}>
  <CardLink href="/docs/api/no-code/zapier" icon="🚀" title="Começar pela trilha Sem Código" span>
    Passo a passo para integrar o GS Engage usando Zapier.
  </CardLink>
</CardGrid>

💻 Trilha Com Código — para quem desenvolve [#-trilha-com-código--para-quem-desenvolve]

Essa trilha é para o **Bruno**: ele é desenvolvedor e quer controle total. O objetivo dele é fazer a primeira chamada funcionar, entender a autenticação e depois aprofundar nos guias e na referência.

Aqui você trabalha diretamente com os **endpoints** (os endereços da API que recebem cada tipo de pedido). A autenticação usa uma **apiKey** (uma chave de cerca de 40 caracteres) enviada como parâmetro na URL, no formato `?apiKey=SUA_CHAVE`.

O trecho abaixo é o teste de verificação recomendado no quickstart: ele confirma que a sua chave funciona sem alterar nenhum dado.

```bash
curl "https://api.gsengage.com/api/v1/custom-fields?apiKey=SUA_CHAVE"
```

Um retorno **200** com uma lista (que pode vir vazia, `[]`, se o projeto ainda não tem campos personalizados) significa que a chave está válida e você já está autenticado. Pronto para o próximo passo.

<Callout type="danger" title="Toda chamada é real">
  Não existe ambiente de teste (sandbox) separado. Toda chamada afeta dados de produção. Ao experimentar, prefira operações de leitura (GET) e avise a equipe antes de qualquer escrita.
</Callout>

<FieldInfoGroup>
  <FieldInfo title="É a sua trilha se...">
    Você escreve código e quer integrar sua aplicação, automatizar fluxos personalizados ou construir algo em cima da API.
  </FieldInfo>

  <FieldInfo title="O que você vai fazer">
    Gerar a chave, validar a autenticação, ler os guias práticos e consultar a referência com os 19 recursos disponíveis.
  </FieldInfo>
</FieldInfoGroup>

<CardGrid cols={1}>
  <CardLink href="/docs/api/comece-aqui/quickstart" icon="⚡" title="Começar pela trilha Com Código" span>
    Faça sua primeira chamada e valide sua chave em poucos minutos.
  </CardLink>
</CardGrid>

📊 Trilha Análise de Dados — para quem mede resultados [#-trilha-análise-de-dados--para-quem-mede-resultados]

Essa trilha é para o **Rafael**: ele é analista e quer transformar o que acontece nas vendas em números. O objetivo dele é extrair dados do GS Engage para alimentar um dashboard (painel) e entender o que cada status significa.

Você vai ler informações de **prospecções** (o acompanhamento de um lead dentro de uma **cadência**, que é a sequência de atividades de contato) e de **leads**, sempre com chamadas de leitura. Um ponto importante para o relatório: os status das prospecções têm um valor técnico e um rótulo em português que o cliente vê no app.

| Status técnico | Rótulo no app |
| -------------- | ------------- |
| `IN_PROGRESS`  | Em andamento  |
| `FROZEN`       | Congelada     |
| `WON`          | Ganha         |
| `LOST`         | Perdida       |

<FieldInfoGroup>
  <FieldInfo title="É a sua trilha se...">
    Você quer puxar dados de prospecções e leads para relatórios, planilhas ou ferramentas de BI, e entender o significado de cada status.
  </FieldInfo>

  <FieldInfo title="O que você vai fazer">
    Fazer chamadas de leitura, lidar com paginação e ordenação, e traduzir os enums técnicos para os rótulos que o time comercial reconhece.
  </FieldInfo>
</FieldInfoGroup>

<CardGrid cols={1}>
  <CardLink href="/docs/api/guias/extrair-para-dashboard" icon="📈" title="Começar pela trilha Análise de Dados" span>
    Aprenda a extrair prospecções e leads para o seu dashboard.
  </CardLink>
</CardGrid>

🤔 Ainda na dúvida? [#-ainda-na-dúvida]

<FAQ>
  <FAQItem question="Posso seguir mais de uma trilha?">
    Pode, sim. As trilhas se complementam. Uma pessoa analista pode começar pela **Análise de Dados** e, se precisar automatizar, passar para a **Com Código**. Escolha pela sua meta imediata.
  </FAQItem>

  <FAQItem question="Não sei programar. A trilha Com Código é para mim?">
    Provavelmente não é o melhor ponto de partida. Comece pela **Sem código** com Zapier, Make ou n8n. Você automatiza bastante coisa sem escrever uma linha.
  </FAQItem>

  <FAQItem question="Preciso de uma chave de API para todas as trilhas?">
    Sim. A **apiKey** é criada na plataforma em Configurações > Configurações de API. Guarde-a como uma senha: como ela viaja na URL, pode aparecer em logs, no histórico do navegador e em links compartilhados. Nunca a cole em canais públicos.
  </FAQItem>
</FAQ>

<Callout type="warning" title="Trate sua chave como senha">
  A `apiKey` vai na URL e, por isso, aparece em logs de servidor, histórico do navegador e links compartilhados. Guarde-a em uma variável de ambiente e nunca a exponha em locais públicos.
</Callout>

Artigos Relacionados [#artigos-relacionados]

<RelatedArticles>
  <RelatedArticle href="/docs/api/comece-aqui/quickstart" title="Quickstart" description="Faça sua primeira chamada e valide sua chave de API." />

  <RelatedArticle href="/docs/api/no-code/zapier" title="Integração com Zapier" description="Conecte o GS Engage a outras ferramentas sem código." />

  <RelatedArticle href="/docs/api/guias/extrair-para-dashboard" title="Extrair para dashboard" description="Puxe dados de prospecções e leads para seus relatórios." />
</RelatedArticles>