Motimate: Como importar a documentação da API pública do Motimate para o Postman?

Introdução

Se você é um desenvolvedor de API, sabe como é importante testar e documentar seu aplicativo para garantir sua funcionalidade e confiabilidade. O Postman é uma ferramenta popular entre os desenvolvedores, pois oferece uma interface fácil de usar para fazer solicitações HTTP, testar pontos de extremidade e visualizar respostas.

Um dos principais recursos dessas ferramentas é a capacidade de importar documentação no formato Open API. Neste artigo, orientaremos você no processo de importação da documentação da API pública do Motimate (no formato Open API 3.0) para uma coleção do Postman, tornando o teste e o desenvolvimento da API mais eficientes.

Requisitos

Antes de começarmos, você precisará ter o Postman instalado em seu sistema. Você pode fazer o download do Postman aqui.

Importar a API do Motimate para as coleções do Postman:

1. Vá para a página de download da documentação da API pública do Motimate(aqui).
    
2. Localize o botão Exportar no canto superior direito e clique nele. Selecione Download API e, em seguida, JSON Unresolved.
    
3. Quando o arquivo tiver sido baixado, abra o Postman.
   
   
    
4. Abra a guia Coleções e clique em Importar. Carregue o arquivo baixado como uma coleção.
   
   
    
5. É hora de configurar nossa autorização - clique em Motimate Public API e, em seguida, selecione a guia Variables (Variáveis).
   
   
    

6. Adicione uma nova variável chamada clientId e defina o valor inicial como o valor fornecido pelo Motimate. O valor atual será atualizado automaticamente.
   
   Então...
   
    

   Adicione uma nova variável chamada clientSecret e defina o valor inicial como o valor fornecido pelo Motimate. O valor atual será atualizado automaticamente.
   
   
   
    

7. Muito importante: clique em Salvar!
   
   
   
    
8. Clique novamente em Motimate Public API e selecione a guia Authorization (Autorização).
   
   
    

9. Defina o tipo como OAuth 2.0. Um formulário deverá ser exibido. Role para baixo até a seção Configure New Token (Configurar novo token ).

   Se você vir a informação "Some changes to the Token…", basta clicar em Edit Token Configuration.
   
   
   
    

10. Defina o tipo de concessão como Credenciais do cliente:
    1. Defina o URL do token de acesso como {{baseUrl}}/oauth/token
    2. Defina a ID do cliente como {{clientId}}
    3. Definir o segredo do cliente como {{clientSecret}}
       
       
       
        
11. Role a tela para baixo e clique em Get New Access Token (Obter novo token de acesso). O Postman deve informar você sobre uma autenticação bem-sucedida. Clique em Proceed e, em seguida, em Use Token.
    
     
12. Muito importante: clique em Salvar!
    
     

13. Clique em: me → fetch Current Organization → Send.

    Você deverá ver uma resposta da API pública da Motimate com os dados da sua organização.
    
    
    
     

    Parabéns! Agora você importou a API pública do Motimate para o Postman Collections 🎉