Postman


Sobre o Postman

Postman ajuda você a ser extremamente eficiente ao trabalhar com APIs, com ele você pode construir solicitações rapidamente, guardá-las para uso posterior e analisar as respostas enviadas pelo API. Postman pode reduzir drasticamente o tempo necessário para testar e desenvolver APIs.

Onde baixar?

Você pode baixar o postman no site: https://www.getpostman.com/.

Importar Arquivo JSON

Ao abrir o Postman é preciso importar o arquivo JSON da API do Canal da Peça, você pode baixar esse arquivo no link API Canal da Peça. Descompacte-o em uma pasta de sua preferência para utilizar na importação.

  • Clique no botão “Import” no canto superior esquerdo
  • Selecione o arquivo JSON da API Canal da Peça
  • Os serviços da API Canal da Peça irão aparecer do lado esquerdo

Gerenciar Ambiente

Para efetuar os testes é preciso configurar o ambiente de testes. A URL para os testes é: ws.hml.autorei.net

Siga os passos abaixo para configurar o ambiente.

  • No canto superior direito clique na engrenagem depois clique em “Manage Environments”
  • Clique em “ADD”
  • Nomeie o ambiente, Ex: API – CDP
  • Preencha o campo key com o valor url
  • Preencha o campo value com a url de testes ws.hml.autorei.net
  • Selecione o ambiente que criou no canto superior direito.

* Essa URL é para o ambiente de testes do Canal da Peça, posteriormente você receberá a URL, usuário e senha para o ambiente de Produção

Requests

Para integrar o seu estoque com o Canal da Peça é preciso que você tenha usuário e senha, solicite os dados para o ambiente de testes enviando um e-mail para: dev@canaldapeca.com.br informando qual é a sua loja. Com o usuário e senha em mãos siga os passos abaixo.

Para testar qualquer serviço é preciso primeiro autenticar na API para receber um TOKEN.

  • Selecione o ambiente no canto superior direito. Ex: API – CDP
  • No menu do lado esquerdo selecione a opção Authentication e em seguida password
  • Na opção Type selecione Basic Auth
  • Insira o clientID e o clientSecret fornecido pelo CDP e clique em Update Request
  • Na aba Body insira seu usuário e senha de lojista
  • Clique em Send para efetuar a autenticação

Você obterá um retorno igual ao abaixo, o atributo access_token será utilizado em todas as requisicões.

Para fazer qualquer consulta ou atualização na API do Canal da Peça é preciso passar o token (atributo access_token no retorno da autenticação) no Header da requisição. Na aba Header de qualquer requisicão existe o campo Authorization e o valor sempre será: Bearer “token”

Para toda requisição feita o Postman gera um código que pode lhe auxiliar a implementar em sua aplicação, para isso basta clicar em code acima do botão Update Request. Essa funcionalidade é de grande ajuda, principalmente se você estiver tendo um erro a equipe do Canal da Peça irá solicitar o cURL gerado para a resolução do problema.