MOWScheduler REST Tools: Insomnia

What is Insomnia?

Insomnia is REST API development tool available for Windows, MacOs, and Linux which allows developers to test out APIs without needing to write any code. It also generates sample code for consuming the API in many different programming languages and toolkits, making your development tasks much easier.

Insomnia can directly import the MOW Scheduler REST API spec in OpenAPI 3.0 format. An up-to-date copy of this spec is publicly available at https://demo.mowscheduler.com/static/openapi.yaml -- Insomnia will load the spec from this URL diring the process outlined below

Recipe: Setting Up the MOWScheduler Insomnia Workspace

  1. Download and install insomnia.
  2. Start up Insomnia. You can skip the Cloud logins and choose "use the local scratch pad"
  3. From the new workspace, click Scratch Pad and choose "import", the supply the OpenAPI url https://demo.mowscheduler.com/static/openapi.yaml and hit the Import button
  4. Browse to find the workspace file from step 2. Insomnia will conform that you now have a MOW REST API workspace.
  5. Under the MOW REST API blue box, click where it says No Environment, then click Manage Environments.
  6. Copy the the base environment JSON shown on the right, we'll use that to make a new environment MOWScheduler install.
  7. Click the plus icon next to Sub Environments, and then click Environment.
  8. Rename this new environment by double clicking on New Environment on the right. Call it something like "My MOWScheduler Environment".
  9. Paste in the JSON from step 7. Change base_url and api_token to match your MOW install. Click Done when you're finished.
  10. Now you can play around with the provided methods for contacts and organizations.