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.
Swagger Consumo de Quantidade de regras
https://app.systax.com.br/auth/swagger#/consumo_regras/consumoConsumoRegras
Listagem do Endpoint que contempla o manual de Consumo de Quantidade de regras
|
Descrição |
Versão |
Grupo Swagger |
Método |
URL Endpoint |
URL Token |
|---|---|---|---|---|---|
| Consulta Consumo de Regras |
v1 |
consumo_regras |
Get |
Autenticação
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
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
| Campo | Descrição |
| message | Retorna se a consulta foi realizada com sucesso ou não |
| id_cliente | Informa o ID do Cliente que o sistema retornou as informações |
| quantidade_regras | Informa a quantidade de regras contratadas |
| regras_consumidas | Informa a quantidade de regras cosumidas até o momento da consulta |
| percentual_consumido | Informa o percentual de regras consumidas até o momento da consulta |
Códigos de retorno
| Código | Msg | Descrição |
| 200 | Ok | Consulta realizada com sucesso |
| 400 | token_invalid | Token inválido |
| 400 | token_expired | Token expirado |
| 500 | internal_error | Erro interno |
Exemplo de retorno
{
"success": true,
"message": "ok",
"id_cliente": 477176,
"quantidade_regras": 1000,
"regras_consumidas": 0,
"percentual_consumido": 0
}