Teste de credencial, tabelas de códigos (combustíveis) e observações livres.
Autenticação em todos os exemplos: veja Autenticação. Teste no navegador pelo Swagger ou importe a coleção do Postman.
| Endpoint | Métodos | Para que serve |
|---|---|---|
status |
GET | Teste de conexão e credencial do terceiro |
tabelas |
GET | Tabelas auxiliares: lista de combustíveis |
txObservacao |
GET, POST, PUT, DELETE | Observações livres ligadas a qualquer registro |
Teste de conexão e credencial do terceiro. Não consulta nada: só confirma que a autenticação (APP/REDE/CNPJ/CPF + SENHA + A) e a permissão do terceiro estão corretas. Útil para testar a conexão da integração. Vale para todos os tipos de terceiro.
/v1/terceiro/statusResponde ok se a credencial é válida
Perfis: App, Rede, Posto, Cliente, Pessoa
curl -s -X GET "$BASE/v1/terceiro/status?$AUTH"
Resposta:
{
"status": "ok"
}
Erros específicos: 401 — credencial inválida.; 403 — sem permissão..
Tabelas auxiliares: lista de combustíveis. Tabelas de códigos para usar nos outros endpoints. Hoje só existe a tabela 1 (combustíveis: os id_comb de venda, preços e agenda).
/v1/terceiro/tabelasConteúdo da tabela pedida
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_tabela |
integer | sim | 1 = combustíveis ativos. |
curl -s -X GET "$BASE/v1/terceiro/tabelas?$AUTH&id_tabela=1"
Resposta:
{
"data": [
{
"id_comb": 1,
"nome_comb": "GASOLINA COMUM"
},
{
"id_comb": 2,
"nome_comb": "ETANOL"
}
],
"status": "ok"
}
Erros específicos: 400 — {registro: 'Falha ao localizar'}: id_tabela diferente de 1..
Observações livres ligadas a qualquer registro. Grava e consulta observações (texto) ligadas a qualquer registro do sistema, identificado por tabela + id. GET por id_tx_observacao devolve uma; por tabela + id devolve a lista. DELETE desativa (ativo = N). A API não verifica se a tabela e o id existem e não restringe pelo escopo do acesso (só pelo app).
/v1/terceiro/txObservacaoConsulta uma observação ou as de um registro
Por id_tx_observacao a resposta é um objeto plano (sem data[]): {status, id_tx_observacao, tabela, id, observacao, data_hora, ativo}.
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_tx_observacao |
integer | não | Id da observação (tem prioridade). |
tabela |
string | não | Tabela (usar junto com id quando não houver id_tx_observacao). |
id |
integer | não | Id do registro na tabela. |
curl -s -X GET "$BASE/v1/terceiro/txObservacao?$AUTH"
Resposta:
{
"status": "ok",
"data": [
{
"id_tx_observacao": 15,
"observacao": "Cliente pediu conferência",
"data_hora": "2026-11-10 09:30:00",
"ativo": true
}
]
}
Erros específicos: 400 — {"errors":{"params":"Você deve passar o id_tx_observacao ou o conjunto (tabela, id)"}}.; 400 — {"errors":{"registro":"Falha ao localizar"}}: o id não existe no app..
/v1/terceiro/txObservacaoCria uma observação
Perfis: App, Rede, Posto, Cliente, Pessoa
Corpo (JSON objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tabela |
string | sim | Nome da tabela do sistema a que a observação se refere (ex.: operacao). |
id |
integer | sim | Id do registro nessa tabela. |
observacao |
string | sim | Texto |
ativo |
boolean | não | true/false |
curl -s -X POST "$BASE/v1/terceiro/txObservacao?$AUTH" \
-H 'Content-Type: application/json' \
-d '{"tabela": "operacao", "id": 9001, "observacao": "Cliente pediu conferência"}'
Resposta:
{
"status": "ok",
"id_tx_observacao": 15
}
Erros específicos: 400 — {"errors":{"body":"O conteúdo não é um JSON válido"}}.; 400 — {"errors":{"exception":""}}: erro de validação ao gravar (ex.: "Dados já cadastrados (id)")..
/v1/terceiro/txObservacaoAltera uma observação (parcial)
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_tx_observacao |
integer | sim | Id da observação |
Corpo (JSON objeto)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tabela |
string | não | Nome da tabela do sistema a que a observação se refere (ex.: operacao). |
id |
integer | não | Id do registro nessa tabela. |
observacao |
string | não | Texto |
ativo |
boolean | não | true/false |
curl -s -X PUT "$BASE/v1/terceiro/txObservacao?$AUTH&id_tx_observacao=" \
-H 'Content-Type: application/json' \
-d '{"observacao": "Texto corrigido"}'
Resposta:
{
"status": "ok"
}
Erros específicos: 400 — {"errors":{"id_tx_observacao":"Inválido"}}.; 400 — {"errors":{"body":"O conteúdo não é um JSON válido"}}.; 400 — {"errors":{"registro":"Falha ao localizar"}}: o id não existe no app.; 400 — {"errors":{"exception":""}}: erro de validação ao gravar (ex.: "Dados já cadastrados (id)")..
/v1/terceiro/txObservacaoDesativa uma observação
Perfis: App, Rede, Posto, Cliente, Pessoa
Parâmetros (query)
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id_tx_observacao |
integer | sim | Id da observação |
curl -s -X DELETE "$BASE/v1/terceiro/txObservacao?$AUTH&id_tx_observacao="
Resposta:
{
"status": "ok"
}
Erros específicos: 400 — {"errors":{"id_tx_observacao":"Inválido"}}.; 400 — {"errors":{"registro":"Falha ao localizar"}}: o id não existe no app.; 400 — {"errors":{"registro":"Falha ao desativar"}}: por exemplo, registro já inativo..