Motimate: Як імпортувати документацію публічного API Motimate до Postman?

Вступ

Якщо ви розробник API, ви знаєте, як важливо тестувати і документувати свій додаток, щоб забезпечити його функціональність і надійність. Postman - популярний інструмент серед розробників, оскільки він надає зручний інтерфейс для створення HTTP-запитів, тестування кінцевих точок та візуалізації відповідей.

Однією з ключових особливостей цього інструменту є можливість імпортувати документацію у форматі Open API. У цій статті ми проведемо вас через процес імпорту документації Motimate Public API (у форматі Open API 3.0) до колекції Postman, що зробить ваше тестування та розробку API більш ефективним.

Вимоги

Перш ніж ми почнемо, вам потрібно встановити Postman у вашій системі. Завантажити Postman можна тут.

Імпортувати API Motimate для колекцій Postman:

1. Перейдіть на сторінку для завантаження документації Motimate Public API(тут).
    
2. Знайдіть кнопку " Експорт " у верхньому правому куті та натисніть її. Виберіть Завантажити API, а потім JSON Unresolved.
    
3. Після завантаження файлу відкрийте Postman.
   
   
    
4. Відкрийте вкладку Колекції та натисніть Імпорт. Завантажте завантажений файл як Колекцію.
   
   
    
5. Час налаштувати нашу авторизацію - натисніть Motimate Public API і виберіть вкладку Змінні.
   
   
    

6. Додайте нову змінну з ім'ям clientId і встановіть початкове значення Initial значення, надане Motimate. Поточне значення оновиться автоматично.
   
   тоді...
   
    

   Додайте нову змінну з ім'ям clientSecret і встановіть початкове значення Initial на значення, надане Motimate. Поточне значення оновиться автоматично.
   
   
   
    

7. Дуже важливо: натисніть "Зберегти"!
   
   
   
    
8. Знову натисніть Motimate Public API і виберіть вкладку Авторизація.
   
   
    

9. Встановіть Тип на OAuth 2.0. Повинна з'явитися форма. Прокрутіть вниз до розділу Налаштування нового токена.

   Якщо ви бачите інформацію "Деякі зміни в токені…", просто натисніть кнопку Змінити конфігурацію токена.
   
   
   
    

10. Встановіть тип гранту на Облікові дані клієнта:
    1. Встановіть URL токена доступу {{baseUrl}}/oauth/token
    2. Встановіть ідентифікатор клієнта на {{clientId}}
    3. Встановіть секрет клієнта на {{clientSecret}}
       
       
       
        
11. Прокрутіть вниз і натисніть " Отримати новий токен доступу". Листоноша повинен повідомити вас про успішну автентифікацію. Натисніть " Приступити ", а потім " Використовувати токен".
    
     
12. Дуже важливо: натисніть "Зберегти"!
    
     

13. Натисніть: я → отримати поточну організацію → Надіслати.

    Ви повинні побачити відповідь від Motimate Public API з даними вашої організації.
    
    
    
     

    Вітаємо! Ви щойно імпортували Motimate Public API до колекцій Postman 🎉.