API pública: primeiros passos

A API pública conecta seus sistemas ao Grupos Inteligentes. Você pode consultar dados e automatizar tarefas sem repetir ações no painel.

Antes de começar

Você precisará de:

acesso à sua conta do Grupos Inteligentes;
uma assinatura Scale ativa;
um local seguro para guardar o token;
uma ferramenta capaz de fazer pedidos HTTPS.

Um token de API funciona como uma senha exclusiva da integração. Ele permite que outro sistema acesse os dados da sua conta.

Como criar um token

Entre no aplicativo do Grupos Inteligentes.
Abra Configurações no menu lateral.
Selecione Tokens de API.
Clique em Criar token.
Digite um nome que identifique a integração.
Confirme em Criar.
Copie o token e guarde-o imediatamente.

Use nomes claros, como Automação de relatórios ou Integração do CRM.

Dica: Guarde o token em um gerenciador de senhas ou de segredos. Nunca o coloque em uma página pública, aplicativo de navegador ou arquivo compartilhado.

Faça seu primeiro pedido

O endereço base da API é:

https://api.gruposinteligentes.com/api

Envie o token no cabeçalho Authorization, precedido pela palavra Bearer.

curl --request GET \
  --url https://api.gruposinteligentes.com/api/v1/redirectors \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $GI_API_TOKEN"

No exemplo, GI_API_TOKEN é uma variável segura no seu sistema. Não substitua essa variável por um token real em códigos compartilhados.

Para pedidos que enviam dados, adicione também este cabeçalho:

Content-Type: application/json

Encontre a operação certa

Abra a referência completa da API para consultar:

os endereços disponíveis;
os campos aceitos em cada pedido;
exemplos de respostas;
os possíveis códigos de erro.

A referência mostra exemplos com o cabeçalho Authorization. Por segurança, execute esses exemplos na sua própria ferramenta.

Limites e validade

Cada token aceita até 60 pedidos por minuto.
Cada token mostra sua própria data de validade no painel.
Tokens vencidos ou revogados deixam de funcionar imediatamente.
Tokens de integração não podem criar, listar ou revogar outros tokens.

Crie um novo token antes do atual vencer. Depois, atualize sua integração e revogue o antigo.

Como revogar um token

Revogue um token perdido, exposto ou que não seja mais usado:

Abra Configurações no aplicativo.
Selecione Tokens de API.
Encontre o token pelo nome.
Clique em Revogar e confirme.

A integração deixa de acessar sua conta assim que você confirma.

Erros comuns

Código	O que significa	Como resolver
`401`	Token inválido, vencido ou revogado	Crie um token e atualize a integração
`403`	O plano atual não permite usar tokens	Ative ou renove o plano Scale
`422`	Algum campo está ausente ou incorreto	Confira os campos na referência da API
`429`	Muitos pedidos em pouco tempo	Aguarde e reduza a frequência dos pedidos

Se ainda precisar de ajuda, envie um e-mail para suporte@gruposinteligentes.com.