Manual de Usuário

Postman — Coleção Orquestrador (legado)

Baixe a coleção Postman v2.1 para testar o contrato legado (POST) do Orquestrador — autenticação e realizar integração (Inclusão).

Visão geral

Esta página disponibiliza a coleção Postman usada para chamar o Orquestrador no modelo legado (endpoints POST em /api/orquestrador/...), alinhado ao Manual de Orientação Técnica e à página Acesso Direto ao Orquestrador Izzi.

Para integrações novas, prefira a Referência REST e a spec em /izzi-rest.

Download

Ficheiro Collection v2.1 (JSON), pronto para Import → Raw text no Postman ou para arrastar para a janela do Postman:

Descarregar Orquestrador.postman_collection.json

Abrir em nova aba (pré-visualizar JSON)

O que a coleção inclui

Pasta / pedidoMétodoURL (variável {{baseURL}})
Realizar Integração → InclusãoPOST{{baseURL}}api/orquestrador/realizar-integracao
Auth - Gerar TokenPOST{{baseURL}}api/orquestrador/gerar-jwt-para-acesso

O pedido Auth - Gerar Token inclui um script de teste que grava o token na variável de coleção authorization_token a partir de response.token, para reutilizar no Authorization: Bearer {{authorization_token}} do pedido de integração.

Variáveis da coleção

Configure no Postman (Collection → Variables):

VariávelUso
baseURLPrefixo do host (ex.: https://seu-host:44304/ — inclua barra final se os paths da coleção o assumirem).
clientIdCredencial do cliente (contrato legado do gerador de JWT).
clientSecretSegredo do cliente.
tenantIdIdentificador do inquilino.
authorization_tokenPreenchido automaticamente após correr Auth - Gerar Token (script de teste).

Nota: A API REST documentada em /izzi-rest usa client_id / client_secret em POST /v1/auth/token (Keycloak). Esta coleção legada usa clientId / clientSecret no corpo do gerar-jwt-para-acesso do Orquestrador — credenciais e formatos diferentes; alinhe com o ambiente que estiver a testar (gateway REST ou backend legado). O time MDS consome exclusivamente o gateway REST (https://apigw-dev.izii.app.br).

Passos rápidos no Postman

  1. Importar o JSON descarregado acima.
  2. Ajustar baseURL (e credenciais) às variáveis da coleção.
  3. Executar Auth - Gerar Token e confirmar que authorization_token foi atualizada (aba Variables ou consola de testes).
  4. Executar Inclusão (ou duplicar o pedido para outros movimentos, se aplicável).

Ficheiro no repositório

A mesma coleção está versionada em services/devportal/public/postman/Orquestrador.postman_collection.json (servida estaticamente por este portal em /postman/Orquestrador.postman_collection.json).