Explicando Componentes do POSTMAN

Nesta área vamos explicar os diferentes componentes do Postman e suas funções. Depois dessa introdução, as próximas partes deste tutorial vão focar na configurações e usos para teste das APIs

A - Environment (Ambiente):
Ambiente para onde serão direcionadas as requisições. Nesta área que serão definidos dados de:

Sugerimos que sejam criados dois ambientes, um com dados de produção e outro para Sandbox, cada um com suas respectivas credenciais e URLs.
Desta maneira se torna muito mais simples realizar testes com o mesmo contrato para ambos os ambientes.

B - Header
Aqui existem o MerchantId/MerchantKey, que por padrão usam os mesmos dados registrados em Environment.

C - Body:
É o conteúdo das Requisições. Aqui é onde você pode alterar ou criar exemplos para a API e validar o conteúdo do seu POST/GET/PUT

D - Collection (Coleções) :
Local que contém todas os exemplos e códigos que podem ser utilizados na API. Aqui existem as criações de transações, consultas e outras funcionalidades que existem nas APIs Cielo.
O número de coleções é ilimitado, ou seja, você pode criar várias coleções para se adequar ao seu estilo de uso do Postman.

Criando Environment Cielo

O primeiro passo na utilização do postman é a criação do ambiente (environment) da API. Essa configuração vai definir quais credenciais e endpoints serão utilizados como padrão, assim evitando a necessidade de realizar configurações a cada teste.

Realizando a criação do ambiente:

1 - No canto superior direito, clique na engrenagem e selecione "Manage environment".

2 - Na tela de gerenciamento, basta preencher as configurações de acordo com a tela abaixo:

3 - Pronto, agora os endereços e credenciais para teste já estão cadastrada. Sugerimos que você crie um ambiente para Produção e um para Sandbox assim,

Na API Cielo Ecommerce as credenciais, MerchantID e MerchantKey, devem coincindir com o ambiente das URLs, ou seja, Credenciais de sandbox funcionam apenas com URLs de Sandbox
No Checkout Cielo não há MerchantKey nem diferença entre Sandbox e produção. Para realizar testes, deve ser ativado o "Modo de Teste". Para mais informações sobre o Modo de teste, acesso o Ambientes e arquitetura da API

Importando uma Collection

A Cielo dispõe de coleções padrões para suas APIs. Você pode importa-las diretamente para o seu POSTMAN e ter todos os exemplos prontos para utilização instantaneamente, sem a necessidade de copia-los diretamente do manual.

Para realizar a importação basta:

1. Acessar a área deste tutorial onde o link da Coleção está disponível e copiá-lo

ℹ️

Importante

Para que a sua coleção sempre esteja atualizada, sugerimos que sempre busque a ultima versão da coleção no manual. O link NÃO ATUALIZA A COLEÇÃO IMPORTADA AUTOMATICAMENTE

2. Com o Postman aberto, use o botão IMPORT, e selecione a opção "IMPORT FROM LINK".

3. Pronto, sua coleção Cielo já está disponível. Basta selecionar Environment e a requisição. Ao clicar em SEND, o Postman vai executar a comunicação com a Cielo.