Pular para conteúdo

Autenticação

Todos os endpoints da API GOB exigem autenticação por API Key.

Como funciona

A autenticação é feita por um único cabeçalho HTTP:

X-Api-Key: SUA_CHAVE_AQUI

Sem chave, sem acesso

Toda requisição deve incluir o cabeçalho X-Api-Key. Requisições sem esse cabeçalho — ou com uma chave inválida — recebem a resposta 401 Unauthorized.

Obtendo a sua chave

A chave de API é fornecida pelo suporte da GOB Soluções. Guarde-a com segurança e não a exponha em código público (front-end, repositórios abertos, etc.).

Definição de segurança

Propriedade Valor
Tipo apiKey
Local header (cabeçalho HTTP)
Nome do cabeçalho X-Api-Key
Escopo Global — aplicada a todos os endpoints

Exemplos

curl -i -H "X-Api-Key: SUA_CHAVE_AQUI" \
  "https://integracao.gob.com.br/api/v1/Account"

curl.exe -i -H "X-Api-Key: SUA_CHAVE_AQUI" `
  "https://integracao.gob.com.br/api/v1/Account"

const res = await fetch(
  "https://integracao.gob.com.br/api/v1/Account",
  { headers: { "X-Api-Key": "SUA_CHAVE_AQUI" } }
);
const data = await res.json();

import requests

res = requests.get(
    "https://integracao.gob.com.br/api/v1/Account",
    headers={"X-Api-Key": "SUA_CHAVE_AQUI"},
)
data = res.json()

cURL no Windows (PowerShell)

No PowerShell, use curl.exe (e não apenas curl, que é um apelido para o Invoke-WebRequest, com outra sintaxe). A quebra de linha no PowerShell é a crase ` — diferente da barra invertida \ do Linux/macOS. Na dúvida, escreva o comando em uma única linha.

Boa prática

Mantenha a chave em uma variável de ambiente ou cofre de segredos, nunca embutida diretamente no código-fonte versionado.