Documentação Geral
Vale a pena relembrar
API:
API de Criação de Empresas Filhas
Objetivo: A API de Criação de Empresas Filhas tem como objetivo principal cadastrar empresas filhas que serão vinculadas a empresa principal (Parceira), que já possui cadastro na Systax.
O acesso da API é feito através da seguinte URL: https://app.systax.com.br/partner/clients
O método utilizado é o POST
Para utilização da API é feita a autenticação de Token e com ele gerado basta informar na API de criação de empresa filha e iniciar cadastro.
Para o preenchimento dos parâmetros da chamada temos os seguintes campos:
Tag |
Descrição |
Entidade |
Nome da entidade (cliente) que será cadastrada |
nome |
Nome da pessoa que será o contato no cliente cadastrado |
|
Email da pessoa que será o contato no cliente cadastrado |
ddd |
DDD da pessoa que será o contato no cliente cadastrado |
telefone |
|
quantidade_regras |
|
ramal |
|
id |
|
Tipo |
Indica o nível de acesso para o usuário que está sendo criado: |
Username |
Usuário do cliente que está sendo cadastrado |
Senha |
|
Nome |
|
|
|
Importante: vale o destaque para o campo "quantidade_regras" que foi incluído com o objetivo de informar a quantidade de regras contratadas, e essa informação é indicada em campo específico no cadastro da empresa, e utilizado na api "quantidade consumo de regras", que por sua vez informa a quantidade contratada x quantidade de regras geradas pela Systax (vide versão 11/02 a 24/02/2023 do e-mail de atualizações que detalha melhor essa API)
Abaixo um exemplo de chamada com cadastro realizado com sucesso:
Chamada completa:
{
"entidade": "Empresa Teste",
"nome": "João",
"email": "joao@empresateste.com.br",
"ddd": "11",
"telefone": "44444444",
"ramal": "44",
"quantidade_regras": 1000,
"user": {
"id": 1,
"tipo": 20,
"username": "empresa_teste",
"senha": "428f2ccb30410a2bf744ada36df6b50a",
"nome": "Pedro",
"email": "pedro@empresaprincipal.com.br"
}
}
Temos os seguintes retornos possíveis, de acordo com o código retornado e mensagem informada:
Código de retorno |
Sucess |
Message |
Descrição |
200 |
True |
ok |
Cadastro feito com sucesso |
400 |
False |
The ( ) field is required |
Campo obrigatório não preenchido |
400 |
False |
token_invalid |
Token incorreto |
400 |
False |
token_expired |
Token expirado |
Conclusão: A API de criação de empresa filha é de extrema importância, pois com ela possível integrar o processo de cadastro de empresas vinculadas com a empresa principal, que é a parceira da Systax. E com essa possibilidade não é necessário que o parceiro em questão fique solicitando a criação para o time da Systax, deixando o processo automatizado
Cockpit:
Exportação de regras com histórico
Com o objetivo de facilitar a verificação das alterações de regras, foi disponibilizado a opção de extração de regras com histórico de regras.
Quando flegada essa opção, o cockpit considerará os filtros da tela e o resultado será a regra com o seu respectivo histórico.
Para utilizar o recurso, basta acessar o cockpit no menu:
>> Mais Opções
>> Exportar Regras
Inserir os filtros, seja pela tela principal da rotina ou pelo filtro personalizado e fazer a flag no item “com Histórico”:
O cockpit processará a requisição e emitirá o relatório de extração com a totalidade das regras:
O relatório será emitido com a linha de cabeçalho e poderá ser visualizado da seguinte forma:
As siglas na primeira coluna indicam se é uma regra “A” – atual ou “H” – histórica.
O relatório de histórico não possui limitação de registros históricos, portanto, ao optar pela extração de regras com histórico, será disponibilizado conforme os filtros definidos na tela, todos os registros atuais e históricos que a empresa tem em seu cockpit.
Esta é uma opção para auxiliar as equipes internas, clientes e parceiros a comparar os campos das regras recepcionadas no cockpit, com a facilidade da visualização em arquivo CSV.
Versão do documento: 29 | Publicação: 3/24/2023 |