Pular para o conteúdo principal

Integração com Postman

Este guia explica como configurar o Postman para autenticar automaticamente nas requisições da API CaaS.

1. Baixar a Collection

Importe a collection pronta com todos os endpoints:

Baixar Collection Postman

No Postman: Import → arraste o arquivo JSON ou cole a URL.

2. Configurar Variável Global

O script de autenticação usa a biblioteca jsrsasign para gerar o JWT. Configure uma variável global:

  1. No Postman, vá em EnvironmentsGlobals
  2. Crie a variável jsrsasign-js
  3. No campo Initial Value, cole a URL: http://kjur.github.io/jsrsasign/jsrsasign-latest-all-min.js
  4. No campo Current Value, acesse a URL acima no browser, copie todo o conteúdo do script e cole aqui

3. Configurar Variáveis de Ambiente

Crie um novo ambiente (ex: Liqi_Sandbox) com estas variáveis:

VariávelValorDescrição
caas_operational_urlhttps://api-caas-it-sandbox.liqi.app.brURL base da API
JWT_SUB(seu ID de chave API)ID obtido ao criar a chave no portal
JWT_PRIVATE_KEY(sua chave privada RSA)Sem prefixos BEGIN/END, sem quebras de linha
aviso

A chave privada (JWT_PRIVATE_KEY) deve ser colada sem os prefixos -----BEGIN RSA PRIVATE KEY----- / -----END RSA PRIVATE KEY----- e sem quebras de linha.

Selecione o ambiente criado no canto superior direito do Postman.

4. Configurar a Requisição de Auth

Crie um POST request para {{caas_operational_url}}/auth/signin.

Na aba Authorization, defina:

  • Type: Bearer Token
  • Token: {{prs_authorization}}

Pre-request Script

Na aba ScriptsPre-request, cole:

var navigator = {};
var window = {};
eval(pm.globals.get("jsrsasign-js"));

var date = new Date();
var now_utc = Date.UTC(
date.getUTCFullYear(), date.getUTCMonth(), date.getUTCDate(),
date.getUTCHours(), date.getUTCMinutes(), date.getUTCSeconds()
);
var issuedAtTimeSeconds = Math.floor(now_utc / 1000);
var expirationTimeSeconds = issuedAtTimeSeconds + 60;

var header = { "alg": "RS256", "typ": "JWT" };
var payload = {
"exp": Math.ceil(expirationTimeSeconds),
"iat": Math.ceil(issuedAtTimeSeconds),
"sub": pm.environment.get("JWT_SUB")
};

var jwt = pm.environment.get("JWT_PRIVATE_KEY");
var prvKey = KEYUTIL.getKey(
"-----BEGIN RSA PRIVATE KEY-----" + jwt + "-----END RSA PRIVATE KEY-----"
);
var sJWT = KJUR.jws.JWS.sign(
header.alg, JSON.stringify(header), JSON.stringify(payload), prvKey
);

pm.collectionVariables.set("prs_authorization", sJWT);

Post-response Script

Na aba ScriptsPost-response, cole:

pm.test("Status test", function () {
pm.response.to.have.status(200);
let response = pm.response.json();
var token = response["token"];
pm.environment.set("operational_authorization", token);
});

5. Usar o Token nas Outras Requisições

Em todas as demais requisições, configure:

  • AuthorizationType: Bearer Token
  • Token: {{operational_authorization}}

O token operacional é salvo automaticamente após o signin. Basta executar a requisição de auth quando precisar renovar.

Ambientes

Para production, crie outro ambiente com caas_operational_url apontando para https://api.liqi-caas.com.br e as chaves correspondentes.

AmbienteURL
Sandboxhttps://api-caas-it-sandbox.liqi.app.br
Productionhttps://api.liqi-caas.com.br