Pular para o conteúdo
GoBots Open API

Primeiros passos

A GoBots Open API dá acesso às métricas de atendimento e ao GoBots Ads da sua conta. Este guia leva você da criação de uma chave até a primeira resposta da API.

Antes de começar

Seção intitulada “Antes de começar”

Sua conta precisa ter o add-on Open API ativo. Sem ele, toda chamada responde 403 com o código not_contracted. Para contratar, fale com o seu consultor GoBots.

1. Crie uma chave de API

Seção intitulada “1. Crie uma chave de API”
  1. Entre no painel GoBots.
  2. Abra Configurações e depois a aba Chaves de API.
  3. Crie uma chave e dê a ela um nome que diga onde ela será usada (por exemplo, BI Looker). Você pode definir uma data de validade; sem data, a chave não expira.
  4. Copie a chave. Ela começa com gb_live_ e aparece só uma vez. Guarde-a em um cofre de senhas ou em uma variável de ambiente, nunca no código.

Cada conta pode ter até 10 chaves ativas. Uma chave revogada para de funcionar na hora, inclusive nos assistentes de IA conectados com ela.

2. Envie a chave em cada requisição

Seção intitulada “2. Envie a chave em cada requisição”

Toda requisição leva a chave no cabeçalho Authorization:

Authorization: Bearer gb_live_...

O endereço base da API é https://open-api.live.gobots.com.br.

3. Chame GET /v1/me

Seção intitulada “3. Chame GET /v1/me”

GET /v1/me mostra a conta, o plano, a chave em uso, os limites do plano e o consumo do mês. É a melhor forma de testar uma chave nova.

Janela do terminal
export GOBOTS_API_KEY="gb_live_..."


curl https://open-api.live.gobots.com.br/v1/me \
  -H "Authorization: Bearer $GOBOTS_API_KEY"

A resposta tem este formato:

{
  "merchant_id": "...",
  "tier": "pro",
  "api_key": { "id": "key_...", "name": "BI Looker", "prefix": "gb_live_AbCd" },
  "limits": {
    "rpm": { "metrics": 300, "ads": 300, "meta": 600 },
    "monthly_quota": 200000
  },
  "usage": {
    "cycle_start": "2026-10-01",
    "cycle_end": "2026-10-31",
    "requests": 0,
    "by_group": { "metrics": 0, "ads": 0 }
  }
}
Campo Significado
tier Plano da conta: starter, pro ou enterprise.
api_key.prefix Prefixo público da chave em uso. A chave completa nunca volta em uma resposta.
limits.rpm Requisições por minuto em cada grupo de rotas.
limits.monthly_quota Requisições por mês nos grupos metrics e ads.
usage Consumo do mês corrente (UTC).

Uma resposta 401 com o código invalid_api_key quer dizer que a chave está ausente, mal formada, revogada ou expirada.

Próximos passos

Seção intitulada “Próximos passos”