Serviços¶
Além da API de dados — que é somente leitura —, a GOB disponibiliza serviços: rotas que executam operações específicas, inclusive de escrita (criar, editar, vincular).
Todos os serviços ficam sob o mesmo caminho base e usam a mesma API Key da API de dados. Cada serviço expõe os seus próprios recursos a partir dele:
Serviços disponíveis¶
-
Gerenciamento de usuários
Crie e edite usuários e controle a carteirização: quais clientes cada usuário enxerga.
/api/v1/services/User -
Radar de Débitos
Consulte os débitos de um cliente apurados na Situação Fiscal, agrupados por código de receita ou detalhados.
/api/v1/services/radar-debito·/api/v1/services/radar-debito-agrupado
Diferenças em relação à API de dados¶
| API de dados | Serviços | |
|---|---|---|
| Caminho | /api/v1/{entity} |
/api/v1/services/{recurso} |
| Operações | Somente leitura (GET) |
Leitura e escrita, conforme o serviço |
| Autenticação | X-Api-Key |
X-Api-Key (a mesma chave) |
| Erros | Sem corpo; motivo no cabeçalho X-Status-Reason |
Corpo JSON em formato próprio de cada serviço (exceto o 401, sem corpo) |
Os serviços atuam em produção
As chamadas feitas pelo seu sistema ou terminal atuam diretamente no ambiente de produção. Nas referências interativas, o Try it out também executa de verdade as requisições GET e POST — por exemplo, criar um usuário ou consultar o radar de débitos. Edições e remoções (PUT e DELETE) não são aceitas a partir do navegador.