Exibir origem

CONTEÚDO

Visão Geral
Exemplo de utilização
Tabelas utilizadas
Informações relacionadas

01. VISÃO GERAL

Essa API tem como função retornar o token de acesso para autenticação no TSS, esses dados retornam encodados.

02. EXEMPLO DE UTILIZAÇÃO

2.1 Namespace da API

- Namespace padrão: /v1/TSSRestAuthentication/Token
- Exemplo: URL REST padrão definida: http://localhost:8081/rest
- Resultado final: http://localhost:8081/rest/v1/TSSRestAuthentication/Token

2.2 Método POST

{
    "GRANT_TYPE": "CLIENT_CREDENTIALS" ou "REFRESH_TOKEN",
    "CLIENT_ID": "CLIENT_ID gerado no TSSINTERFACE",
    "CLIENT_SECRET": "CLIENT_SECRET gerado no TSSINTERFACE",
    "REFRESH_TOKEN": "3600"
}

Estrutura esperada
Campo	Tipo	Tamanho	Observação
GRANT_TYPE	string	18	Se é atualização do token ou uma nova credencial.
CLIENT_ID	string	-	Client_id gerado no tssinterface.
CLIENT_SECRET	string	-	Client_Secret gerado no tssinterface.
REFRESH_TOKEN	string	-	Tempo para expiração do Token.

{
    "ACCESS_TOKEN": "Token Gerado",
    "EXPIRES_IN": 3600,
    "REFRESH_TOKEN": "Refresh Token gerado",
    "TOKEN_TYPE": "Bearer"
}

{
   "status":400,
   "message":"Erro na estrutura do json",
}

Estrutura - JSON
Campo	Tipo	Estrutura pai	Descrição	Observação
status	Numérico	-	Código de status de retorno.	Sucesso: 200 Falha: 400
message	String	-	Indica se a requisição foi bem-sucedida.	Em caso de retorno negativo: Mensagem com a descrição do erro.
ACCESS_TOKEN	String	-	Retorna o token gerado encodado.	Retornado apenas em caso de sucesso.
EXPIRES_IN	Numeric	-	Retorna o tempo de expiração do token	Retornado apenas em casos de sucesso.
REFRESH_TOKEN	string	-	Retorna o token de refresh gerado encodado.	Retornado apenas em casos de sucesso.
TOKEN_TYPE	string	-	Retorna o tipo do token.	Retornado apenas em casos de sucesso.

Retorno de sucesso possíveis
Descrição	Observação
Sucesso	Estrutura completa com os dados requeridos

Retorno de erro possíveis
Descrição	Observação
Erro na estrutura do JSON	Validar se a estrutura confere com o modelo esperado.
Dado incorreto: *campo, esperado caractere*	Dado informado no campo, foi diferente de string.
Estrutura incorreta parte faltante *campo*	Validar se todos os campos necessários foram informados na requisição.
Falha ao gerar o token, verifique os dados informados.	Validar se as credenciais enviadas estão corretas.

03. TABELAS UTILIZADAS

TSS0012.

04. Informações relacionadas

Para o uso da API é necessário que o arquivo Printer.exe, esteja na pasta do AppServer do TSS.
Configuração do REST: Configuração REST