Pular para conteúdo
Documentação oficial

API GOB

Consulta a 41 entidades fiscais e contábeis e serviços de gestão de usuários e consulta de débitos, autenticados por API Key. Simples, previsível e seguro.

Começar agora Serviços Referência interativa

O que é a API GOB

A API GOB reúne duas partes, autenticadas pela mesma API Key no cabeçalho X-Api-Key:

  • API de dados — consulta somente leitura (GET) às entidades de dados fiscais e contábeis da plataforma GOB Soluções;
  • Serviços — operações específicas, como gerenciar usuários e carteiras e consultar o radar de débitos de um cliente.

Novo por aqui? Siga o Comece aqui.

Chave de acesso

A chave de API é fornecida pelo suporte e deve ser enviada em todas as requisições. Sem ela, a resposta será 401 Unauthorized.

  •   Autenticação por API Key

    Um único cabeçalho X-Api-Key protege todos os endpoints. Saiba como obter e enviar a sua chave.

    Autenticação

  •   Consultas flexíveis

    Pagine, ordene, selecione campos e combine filtros complexos usando searchParams (JSON codificado na URL).

    Como consultar

  •   Filtros poderosos

    Mais de 40 operadores where — de equals e contains a filtros de data e arrays.

    Filtros e operadores

  •   41 entidades

    Clientes, certidões, parcelamentos, procurações, situação fiscal e muito mais.

    Entidades disponíveis

  •   Serviços

    Gerenciamento de usuários e carteiras e consulta do radar de débitos, em /api/v1/services.

    Ver serviços

Em resumo
Host integracao.gob.com.br
Protocolo HTTPS
Base path /
Autenticação API Key no cabeçalho X-Api-Key
Formato application/json
Operações API de dados: somente leitura (GET) · Serviços: conforme o serviço
Entidades 41 disponíveis para consulta
Serviços /api/v1/services/* — ver lista

Primeira requisição

Uma consulta mínima a uma entidade — por exemplo, Account (Cliente):

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"

A forma recomendada de filtrar é com searchParams, um JSON codificado na URL:

const searchParams = {
  maxSize: 50,
  offset: 0,
  select: ["modifiedAt", "name", "sicCode"],
  orderBy: "modifiedAt",
  order: "desc",
  where: [{ type: "startsWith", attribute: "sicCode", value: "123" }]
};

const url = `https://integracao.gob.com.br/api/v1/Account?searchParams=${encodeURIComponent(JSON.stringify(searchParams))}`;

Ver o guia completo de consultas