Documentação Geral

API – API de Consumo de Quantidade de Regras – Nova URL


    Nova URL da API de Consumo de Quantidade de Regras

     

    A nova URL da API tem como característica ser exclusiva para parceiros e retornar a informação de todas as empresas filhas vinculadas a ela, de forma que não é necessário realizar uma consulta para cada empresa filha. Com isso, o processo de consulta ficou mais rápido.


    URL: http://app.systax.com.br/partner/clients/consumo-regras

    Método: GET

     

    A API não trabalha com body e nem com informação na URL. É através da autenticação que ela vai identificar qual o parceiro está realizando a consulta, e assim identificar quais as empresas filhas serão listadas no retorno.


    Veja no exemplo a seguir que, após informar o token gerado, basta chamar a API e verificar o retorno:

    Após chamar a API, no retorno irá listar todas as empresas filhas vinculadas ao parceiro em questão, conforme print abaixo:


     

    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

     

    Conclusão: A nova API de Consumo de Quantidade de Regras vai automatizar a consulta das regras contratadas e consumidas das empresas filhas, diminuindo dessa forma o tempo do processo para o parceiro.

    Voltar


Versão do documento: 30 Publicação: 4/6/2023 7