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 do usuário cadastrado |
|
tipo |
Indica o nível de acesso para o usuário que está sendo criado. |
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 |