Skip to main content

Manual de cadastro de estabelecimento e clientes

Manual contendo as últimas atualizações efetuadas em 07/03/2024.

Acesso

Link documentação técnica: https://app.systax.com.br/partner/swagger#/

Introdução

Este documento destina-se à equipe de desenvolvimento responsável por integrar aplicações interna...

Autenticação

A autenticação da API de Parceiros é feita via bearer token. Para mais detahes de como obtê-la, a...

Consulta de cenários

O objetivo dessa API é realizar a consulta de todos os usuários cadastrados na empresa filha dese...

Acesso

URL: https://app.systax.com.br/partner/users/{child_client_id}Método: GETImportante: No lugar do ...

Descrição dos campos da chamada e retorno

Chamada Essa API não possui corpo de chamada, portanto a única informação necessária é o token g...

Exemplo de retorno

{    "success": true,    "message": "ok",    "record_count": 5,    "data": [        {            ...

Criação de usuários

Essa API tem o objetivo de cadastrar um usuário para uma empresa filha.

Acesso

URL: https://app.systax.com.br/partner/users/{child_client_id}Método: POSTImportante: No lugar do...

Descrição dos campos da chamada e retorno

Chamada Tag Descrição Obrigatório tipo Indica o nível de acesso ...

Exemplos de chamada e retorno

Chamada {  "tipo": 10,  "username": "joao_teste",  "senha": "8e7894fe02dffc89c3ac8c55143e0481", ...

Alteração de usuários

Essa API tem o objetivo de alterar os dados de usuários que estejam cadastrados numa empresa filha.

Acesso

URL: https://app.systax.com.br/partner/users/{child_client_id}/{id_user}Método: PUT

Descrição dos campos da chamada

Chamada Tag Descrição Obrigatório Senha Altera a senha do usuári...

Exemplos de chamada e retorno

Chamada {      "senha": "",    "nome": "Empresa Teste 2",    "email": "" } Retorno {    ...

Exclusão de usuários

Essa API tem o objetivo de excluir usuários que estejam cadastrados numa empresa filha.

Acesso

URL: https://app.systax.com.br/partner/users/{child_client_id}/{id_user}Método: DEL

Descrição dos campos da chamada

Chamada Essa API não possui corpo de chamada, portanto a única informação necessária é o token g...

Exemplos de retorno

Retorno {    "success": true,    "message": "ok"}

Consulta de empresas filhas

Esta API tem como objetivo a apresentação, em forma de lista, dos dados das empresas filhas.

Acessos

URL: https://app.systax.com.br/partner/clients Método: GET

Exemplos de chamada e retorno

Chamada   Retorno Campo Descrição id Corresponde ao ID da empresa...

Criação de empresas filhas

Essa API tem o objetivo de cadastrar empresas filhas que serão vinculadas a empresa principal, qu...

Acessos

URL: https://app.systax.com.br/partner/clientsMétodo: POST

Descrição dos campos da chamada

Tag Descrição Obrigatório entidade Nome da entidade (cliente) que...

Exemplos de chamada e retorno

Chamada {  "entidade": "Empresa Teste",  "nome": "João",  "email": "joao@empresateste.com.br",  ...

Alteração de empresas filhas

Essa API tem o objetivo de alterar informações cadastrais de uma empresa filha.

Acessos

URL: app.systax.com.br?/partner?/clients?/{child_client_id}Método: PUT

Descrição dos campos da chamada

Campo Descrição entidade Nome da entidade (cliente) que será cadastrad...

Exemplos de chamada e retorno

Chamada {  "entidade": "string",  "nome": "string",  "email": "string",  "ddd": "string",  "tele...

Exclusão de empresas filhas

Essa API tem o objetivo de excluir uma empresa filha.

Acessos

URL: app.systax.com.br/partner/clients/{child_client_id}Método: DEL

Descrição dos campos da chamada

Essa API não possui corpo de chamada, portanto a única informação necessária é o token gerado e o...

Exemplo de retorno

Retorno { "success": true, "message": "ok" }

Consulta de informações de licença

O objetivo dessa API é consultar as informações das licenças de serviços da empresa filha

Acesso

URL: app.systax.com.br/partner/licenses/clients/{id_servico}/{child_client_id}Método: GET

Descrição dos campos da chamada e retorno

Essa API não possui corpo de chamada, portanto a única informação necessária é o token gerado, o ...

Alteração de licenças

Esta API tem como objetivo efetuar chamadas para alteração de informações de licença de serviço.

Acesso

URL: app.systax.com.br/partner/licenses/clients/{id_servico}/{child_client_id} Método: PUT

Exemplos de chamada e retorno

Chamada {  "dt_expiracao": "23/11/2019",  "tipo_servico": "standard"}   Retorno {  "success":...

Exclusão de licenças

Essa API é utilizada quando é necessário realizar a exclusão de alguma licença de empresa filha.

Acesso

URL: app.systax.com.br/partner/licenses/clients/{id_servico}/{child_client_id} Método: DEL

Exemplo de resposta

{  "success": true,  "message": "string"}

Cadastro de licenças

API utilizada para cadastro de alguma licença para uma empresa filha.

Acesso

URL: app.systax.com.br/partner/licenses/clients/{child_client_id}

Exemplo de chamada e resposta

Chamada {  "id_servico": 0,  "dt_expiracao": "23/11/2019",  "tipo_servico": "standard"}   Reto...

Consulta de estabelecimentos

Utiliza-se esta API para realizar a consulta de um estabelecimento na Systax; Os filtros de busc...

Acesso

URL: app.systax.com.br/partner/company-establishments/{child_client_id} Método: GET

Exemplo de retorno

Retorno {  "success": true,  "message": "string",  "record_count": 0,  "data": [    {      "id":...

Cadastro de estabelecimentos

API utilizada para cadastro de um estabelecimentos.

Acesso

URL: app.systax.com.br/partner/company-establishments/{child_client_id} Método: POST

Exemplos de chamada e retorno

Chamada {  "id": 0,  "id_cli": 0,  "cnpj": "string",  "ie": "string",  "nome": "string",  "email...

Alteração de estabelecimentos

API utilizada quando for necessário realizar alguma alteração de informação do estabelecimento. ...

Acesso

URL: app.systax.com.br?/partner?/company-establishments?/{child_client_id}?/{id_estabelecimento} ...

Exemplos de chamada e retorno

Chamada {  "id": 0,  "id_cli": 0,  "cnpj": "string",  "ie": "string",  "nome": "string",  "email...

Exclusão de estabelecimentos

API utilizada quando for necessário excluir algum estabelecimento cadastrado anteriormente.

Acesso

URL: app.systax.com.br/partner/company-establishments/{child_client_id}/{id_estabelecimento} Mét...

Exemplos de retorno

Retorno { "success": true, "message": "string" }
Back to top