Consulta de Usuários

• Acesso
• Descrição dos campos da chamada e retorno
• Exemplo de retorno

Acesso

URL: https://app.systax.com.br/partner/users/{child_client_id}
Método: GET
Importante: No lugar do {child_client_id} será informado o ID da empresa filha na qual os usuários cadastrados serão consultados

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 gerado e o ID da empresa filha na qual a consulta será feita, que é informado na própria URL, conforme exemplo abaixo:

 

Retorno

Tag	Descrição
id	Informa o id que foi gerado no momento da criação do usuário. É o código único de identificação dele
username	É o usuário que foi cadastrado e que é utilizado como credencial de acesso no uso das API's
nome	Nome do usuário cadastrado
email	Email do usuário cadastrado
tipo	Indica o nível de acesso para o usuário que está sendo criado. Variáveis possíveis: "10" para Admin Empresa Usuária "20" para Operador Empresa Usuária

 

Códigos de retorno

Código de retorno	Sucess	Message	Descrição
200	true	ok	Consulta efetuada com sucesso
400	false	missing_token	Token não informado
400	false	token_invalid	Token informado está incorreto ou expirou
400	false	empresa xxx não é filha do parceiro ou não existe	O ID Cliente informado na URL não existe ou não é filho do parceiro

Exemplo de retorno

{
    "success": true,
    "message": "ok",
    "record_count": 5,
    "data": [
        {
            "id": 1,
            "username": "empresa.teste1",
            "nome": " Empresa Teste 1",
            "email": "empresa.teste1@systax.com.br",
            "tipo": 20
        },
        {
            "id": 2,
            "username": "empresa.teste2",
            "nome": "Empresa Teste 2",
            "email": "empresa.teste2@systax.com.br",
            "tipo": 20
        },
        {
            "id": 3,
            "username": "empresa.teste3",
            "nome": "Empresa Teste 3",
            "email": "empresa.teste3@systax.com.br",
            "tipo": 10
        },
        {
            "id": 4,
            "username": "empresa.teste4",
            "nome": "Empresa Teste 4",
            "email": "empresa.teste4@systax.com.br",
            "tipo": 10
        },
        {
            "id": 5,
            "username": "empresa.teste5",
            "nome": "Empresa Teste 5",
            "email": "empresa.teste5@systax.com.br",
            "tipo": 10
        }
    ]
}