How to import Motimate Public API Documentation to Insomnia Collection?

Introduction

If you're an API developer, you know how important it is to test and document your application to ensure its functionality and reliability. Postman and Insomnia are popular tools among developers as they provide a user-friendly interface to make HTTP requests, test endpoints, and visualize responses. One of the key features of these tools is the ability to import documentation in Open API format. In this article, we will guide you through the process of importing Motimate Public API documentation (in Open API 3.0 format) into an Insomnia collection, making your API testing and development more efficient.

Requirements

Before we start, you will need to have Insomnia installed on your system. You can download Insomnia here.

Step one: import

1. Open Insomnia and click on the "Create" button.
   
   
2. Select the "Import from URL" option.
   
   
   
   
3. Create an Insomnia collection from the URL
   
   
4. Enter the following URL: https://motimate.motimateapp.com/public_api/docs.json
   
   
5. Click on the "Fetch and Import" button.
   
   
   
   
6. Choose “Request Collection” when asked how would you like to import the API.
   
   
   
   
7. Insomnia will inform you about the successful import with “Import Succeeded” dialog. Click “Ok”.
   
   
   
   
8. The collection is now imported. Click on it to see the collection details.

          New collection imported from the documentation

Request collection details. Requests are grouped into resources, like Groups and Users.

Step two: authorization

1. Find POST /oauth/token request in the “Tokens” section. You should see a response body example with client_id, client_secret and grant_type.
   
   On the left side you can see the selected request: POST /oauth/token. On the right side you can see a request body example.
   
   
2. Replace client_id and client_secret in the response body example with your own client ID and client secret. If you don’t have them already, please contact Motimate Customer Support.
   
   
3. Set grant_type to client_credentials.
   
   
4. Click on the "Send" button to submit the request. The response you receive should include the access_token.
   
   
   
   
5. Now you need to configure the collection environment. To do this, you can either use a shortcut (on Mac, press Command+E) or click on "OpenAPI env motimateapp.com" and select "Manage Environments".
   
   
   
   
6. You should see a JSON structure witch scheme, base_path, host and bearerToken. The baererToken token value is initially set to "baererToken". Start replacing it with “response”. A list of possible so-called “functions” should be displayed. Choose “Response ➔ Body Attribute”.
   
   
   
   
7. To configure the function, click on the red tag which indicates that the configuration is incomplete. This will prompt the display of the "Edit Tag" window.
   
   
   Red tag indicating that a function is incomplete
   
   
   Edit Tag window
   
   
8. Fill the form as shown below:

      9. Filled Edit Tag form. Please note the access token visible in Live Preview section.

    10. Click “Done”. The previously red tag representing your bearerToken should be now                            replaced with a green one titled “Response ➔ Body Attribute”.

     11. NB! Don’t click the “Close” button right away. Insomnia won’t remember the changes                         you’ve just made! Instead, click anywhere on the screen first, and then click the “Close”                         button.

     12. Now you can test your configuration. The best way to do this is to send a GET /me request                 (from the “Me” section). If you’ll see your Organization data in the response, then                                     congratulations - you’ve successfully imported Motimate Public API documentation!