Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

POST  /api/broker/estabelecimento/login

Esta seção contém informações detalhadas sobre o modo de autenticação que utilizamos em nossa plataforma. O endoint endpoint de autenticação retorna um Token JWT, os quais contem as credenciais do usuário, e este token precisara ser enviado no Authorization Header de todas as requisição HTTP, utilizando o modo Bearer <token>.

POST      /api/broker/estabelecimento/login

Endpoint responsável autenticar o usuário no sistema TMPay Broker, retornando um Bearer Token, obrigatório nos Headers em todos os requests a API.. Para Autenticar um Estabelecimento, o Parceiro precisar estar Previamente Autenticado.

Headers    

Content-Type

application/json

Authorization

Bearer {token}

Request Body    application/json

Schema:

Campos

Tipo

Descrição

Obrigatório

UserName

StringUsuario

Nome do Usuário

ObrigatórioSim

Password

String

Senha para Acesso

ObrigatórioSim

 

JSON:{
"UserName": “TesteBroker”,
"Password": “123456”

Code Block
languagejson
{
    "userName": "TesteBroker",
    "password": "123456"
}

Response Body    application/json

Schema:

Campo

Tipo

Descrição

Created

Long

Data em formato Unix Epoch da criação do Token (Segundos desde 01/01/1970)

Expires_In

Long

Tempo em segundos para a expiração do Token

Access_Token

String

Bearer Token

UserId

Guid

ID que identifica o usuario que gerou o Token

Token_Type

String

Tipo do Token (Bearer)

RoleLevel

Int32

Níve da Role

(Estabelecimento: 0)

IdEstabelecimento

Int32

ID que identifica o estabelecimento do usuário que gerou o Token

IdDispositivo

Int32

ID que identifica o dispositivo utiliado para gerar o Token

IdEstabelecimentoOperador

Int32

ID que identifica o operador que gerou o Token

CodigoRetorno

Int32

Código que identifica se a autenticação foi efetuada com sucesso

(Sucesso: 1)

MensagemRetorno

String

Mensagem que descreve o campo CódigoRetorno

 

Segue abaixo exemplo de autenticação na API utilizando Postman:

C#

Code Block
var client = new RestClient("https://localhost:44380/api/Autenticacao/login");

var request = new RestRequest(Method.POST);

request.AddHeader("Content-Type", "application/json");

request.AddParameter("application/json", "{\n\t\"UserName\" : \"caio.fontes\",\n\t\"Password\": \"123456\"\n}",  ParameterType.RequestBody);

IRestResponse response = client.Execute(request);

Console.WriteLine(response.Content);

PHP

...

...

JSON:

Code Block
languagejson
{
    "created": 13212313212,
    "expires_In": 5165155,
    "access_Token": "uasdflsnavin90a9d.eyJ1bmlxdWVfbmFtZSI6IkJpdFNlZ3Vyb3MiLCJqdGkiOiIwYTRjNjY5ZjkzY2M0NDhkOGM1ZmMwODQ3MTUyZGZjYiIsIk5ldENvcmVVc2VySWQiOiI1NzAxNDU5MC03ZTc3LTQ2ZjEtY2NhMy0wOGQ4NzU1NWE3NDAiLCJSb2xlTGV2ZWwiOiIxIiwiTm9tZUNsaWVudGVCcm9rZXIiOiJCaXRTZWd1cm9zIiwiSWRQYXJjZWlybyI6IjQiLCJJZFJlZGUiOiIxIiwiSWRFc3RhYmVsZWNpbWVudG8iOiIwIiwiSWRFc3RhYmVsZWNpbWVudG9PcGVyYWRvciI6IjAiLCJuYmYiOjE2MDc2Mjg3NjcsImV4cCI6MTc2NTMwODc2NywiaWF0IjoxNjA3NjI4NzY3LCJpc3MiOiJTc29BdWRpZW5jZSIsImF1ZCI6IlNzb0F1ZGllbmNlIn0.gIr17raPnYoFX_IIj7KqG1prdKyET6mNZeYXv3sf8sA",
    "userId": "51034597-9e13-46f1-cca3-01d37555a740",
    "token_Type": "Bearer"
}