# Documentação - Retorno de Regras e Quantidades Contratadas

# Introdução

Esta API tem como objetivo retornar a quantidade de regras contratadas e consumidas (em quantidade e porcentagem) até o momento da consulta

# Acesso

**Comunicação:** REST/JSON  
  
**Para acessar a coleção de chamadas** [Clique Aqui](https://www.dropbox.com/scl/fi/f0562vw1f67568lqkaogn/API-Quantidade-de-Regras-contratadas.v1.postman_collection.json?rlkey=8nxzffj26wndan75to9e2efsv&dl=0).

**Swagger Consumo de Quantidade de regras**  
[https://app.systax.com.br/auth/swagger#/consumo\_regras/consumoConsumoRegras](https://app.systax.com.br/auth/swagger#/consumo_regras/consumoConsumoRegras "https://app.systax.com.br/auth/swagger#/consumo_regras/consumoconsumoregras")  
  
**Listagem do Endpoint que contempla o manual de Consumo de Quantidade de regras**

<table border="2" id="bkmrk-descri%C3%A7%C3%A3o-vers%C3%A3o-gru"><thead><tr><th scope="col">Descrição

</th><th scope="col">Versão

</th><th scope="col">Grupo Swagger

</th><th scope="col">Método

</th><th scope="col">URL Endpoint

</th><th scope="col">URL Token

</th></tr></thead><tbody><tr><td>Consulta Consumo de Regras</td><td>v1

</td><td>consumo\_regras</td><td>Get

</td><td>[http://app.systax.com.br/  
cadastro-geral/consumo-regras](http://app.systax.com.br/cadastro-geral/consumo-regras "http://app.systax.com.br/cadastro-geral/consumo-regras")

</td><td>[https://app.systax  
.com.br/auth/  
access-token](https://app.systax.com.br/auth/access-token)

</td></tr></tbody></table>

# Autenticação

<main class="col-6" id="bkmrk-a-autentica%C3%A7%C3%A3o-deve-">A autenticação deve ser feita através do bearer token.

Para mais informações sobre o token:

[Manual da API de geraç... | Systax Documentação](https://documentacao.systax.com.br/books/manual-da-api-de-geracao-de-token)  
<div>---

</div></main>

# Descrição dos campos de chamada e retorno

Método: GET

Ao enviar a consulta é feita a identificação do cliente de acordo com as credenciais de autenticação.

  
**Retorno**

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-mess"><tbody><tr><td>**Campo**</td><td>**Descrição**</td></tr><tr><td>message</td><td>Retorna se a consulta foi realizada com sucesso ou não</td></tr><tr><td>id\_cliente</td><td>Informa o ID do Cliente que o sistema retornou as informações</td></tr><tr><td>quantidade\_regras</td><td>Informa a quantidade de regras contratadas</td></tr><tr><td>regras\_consumidas</td><td>Informa a quantidade de regras cosumidas até o momento da consulta</td></tr><tr><td>percentual\_consumido</td><td>Informa o percentual de regras consumidas até o momento da consulta</td></tr></tbody></table>

**Códigos de retorno**

<table border="1" cellpadding="1" cellspacing="1" id="bkmrk-c%C3%B3digo-msg-descri%C3%A7%C3%A3o"><tbody><tr><td>Código</td><td>Msg</td><td>Descrição</td></tr><tr><td>200</td><td>Ok</td><td>Consulta realizada com sucesso</td></tr><tr><td>400</td><td>token\_invalid</td><td>Token inválido</td></tr><tr><td>400</td><td>token\_expired</td><td>Token expirado</td></tr><tr><td>500</td><td>internal\_error</td><td>Erro interno</td></tr></tbody></table>

# Exemplo de retorno

{  
 "success": true,  
 "message": "ok",  
 "id\_cliente": 477176,  
 "quantidade\_regras": 1000,  
 "regras\_consumidas": 0,  
 "percentual\_consumido": 0  
}