DOCUMENTAÇÃO CORPORATIVA

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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 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>. Para acessar esse método o Parceiro precisa estar previamente autenticado, a fim de garantir a segurança e autorização do mesmo.


Request Body    application/json

Schema:

UserName

String

Usuario

Obrigatório

Password

String

Senha

Obrigatório

 

JSON:

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

Response Body    application/json

Schema:

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#

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

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://localhost:44380/api/Autenticacao/login",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\n\t\"UserName\" : \"caio.fontes\",\n\t\"Password\": \"123456\"\n}",
  CURLOPT_HTTPHEADER => array(
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

  • No labels