Criação de empresas filhas
Essa API tem o objetivo de cadastrar empresas filhas que serão vinculadas a empresa principal, que já possui um cadastro na Systax.
Acessos
URL: https://app.systax.com.br/partner/clients
Método: POST
Descrição dos campos da chamada
|
Tag |
Descrição |
Obrigatório |
|
entidade |
Nome da entidade (cliente) que será cadastrada |
Sim |
|
nome |
Nome da pessoa que será o contato no cliente cadastrado |
Sim |
|
|
Email da pessoa que será o contato no cliente cadastrado |
Sim |
|
ddd |
DDD da pessoa que será o contato no cliente cadastrado |
Sim |
|
telefone |
Telefone da pessoa que será o contato no cliente cadastrado |
Sim |
|
quantidade_regras |
Informa a quantidade de regras contratadas |
Não |
|
ramal |
Ramal da pessoa que será o contato no cliente cadastrado |
Não |
|
id |
Corresponde ao ID da empresa parceira da Systax ao qual o cliente cadastrado será vinculado |
Sim |
|
tipo |
Indica o nível de acesso para o usuário que está sendo criado. |
|
|
username |
Usuário do cliente que está sendo cadastrado |
Sim |
|
senha |
Senha do cliente que está sendo cadastrado |
Sim |
|
nome |
Nome da pessoa responsável pelo cadastro feito |
Sim |
|
|
Email da pessoa responsável pelo cadastro feito |
Sim |
|
flag_aprovacao_auto_regras |
Indica se o cockpit do cliente possui aprovação automática de regras. |
Sim |
Códigos de retorno
|
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 |
Exemplos de chamada e retorno
Chamada
{
"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"
}
}
Retorno
{
"success": true,
"message": "string",
"id_cliente": 1,
"id_user": 1
}