Skip to main content

2. api.rule - API principal

Esta API é responsável pelo consumo de qualquer endpoint de qualquer resource.

Dados gerais da requisição

POST /api.rule?sys=ERP HTTP/1.1
Content-Type: application/json
Authorization: token 96F2E34E-128C-48E3-819A-F4014691DD6C

{
	"resource": "resource",
	"endpoint": "endpoint",
	"versao": "v1",
	"tagnomedoendpoint":[
		{
			"idconsumer":"xxxx"
			/* demais tags conforme o endpoint invocado */
		}
	]  
}

Especificação das tags

Tag N Obrigatório Descrição
resource 1 Sim Nome do grupo de endpoints disponíveis
endpoint 1 Sim Nome do endpoint a ser consumido dentro do grupo (resource)
versao 1 Sim Versão do endpoint. Tem a finalidade de manter compatibilidade entre endpoints de versões anteriores
tagnomedoendpoint 1 Nome simbólico

Este nome deve ser composto da string fixa tag+nome do endpoint

Exemplo: taggetveiculositdthr
Neste exemplo, o endpoint é getveiculositdthr

Esta tag sempre será uma lista de itens.
idconsumer 2 Não Pode ser preenchida com um valor alfanumérico definido pelo sistema ou ator que consome o endpoint.
O valor informado será retornado na resposta do endpoint exatamente como foi enviado na requisição.

✅ Resposta de Sucesso

{
	"erromensagem": "",
	"tagnomedoendpoint":[
		{
			"erromensagemitem": "",
			"idconsumer":"xxxx"
			/* demais tags conforme o endpoint invocado */
		}
	]  
}

Especificação das tags da resposta

Tag N Obrigatório Descrição
erromensagem 1 Sim Erro que ocorreu no corpo total da requisição, se não houve erros, esta tag estará vazia
Se ocorrerem erros, a tagnomedoendpoint não será devolvida
tagnomedoendpoint 1 Não Devolvida com o mesmo nome estabelecido na tag da requisição
Sempre será uma lista
erromensagemitem 2 Sim Erro que ocorreu no item específico
idconsumer 2 Não Devolve o conteúdo informado na requisição
Cada endpoint devolverá um conjunto de tags próprias.

❌ Possíveis Erros

- `400 Bad Request`
  - JSON de parâmetros inválido
- `401 Unauthorized` → Credenciais inválidas.
  - Header Authorization não informado
  - Header Authorization informado não inicia com "token"
  - Token informado é inválido
- `405 Method Not Allowed`
  - Tentativa de acesso ao endpoint com método diferente de POST.
Back to top