Extra Horizon
GitHub
  • Extra Horizon Documentation
  • Getting Started
    • Start familiarizing yourself
  • Tutorials
    • Medical Device Tutorial
      • Preparation
      • Build your first prototype
        • Define a data model
        • Configure your workflows
          • Workflow 1: Analyze a measurement
          • Workflow 2: Create & store a PDF report
          • Workflow 3: Send an e-mail
        • Define your permissions
          • Update your schema with user permissions
          • Update your schema with group permissions
        • Build the Front-End
          • Set up oAuth in your backend
          • Demo login page
      • Summary & Wrap up
    • Polysomnography (PSG) Tutorial
    • Retool - Building dashboards Tutorial
  • FAQ
    • General
  • Services
    • Identity and Access Management
      • User service
        • Users
        • Groups
        • Global roles
        • Configuration
      • Auth Service
        • Applications
        • OAuth2
        • OAuth1
        • MFA
        • OpenID Connect
          • Google Cloud
          • Azure ADFS
    • Data Management
      • File Service
      • Data Service
        • Schemas
        • Documents
        • FAQ Data Service
    • Automation
      • Task Service
        • Functions
        • Tasks
        • API Functions
        • Examples
          • Hello world (JS)
          • Hello world (Py)
          • Hello world (Docker)
        • FAQ
      • Dispatchers Service
      • Event Service
        • System Events
    • Communication
      • Notification Service
        • Notifications
        • Settings
      • Mail Service
    • Other
      • Localization Service
        • Language Codes
      • Template Service
        • Localizations
      • Payments Service
        • Subscriptions
        • Stripe
        • iOS App Store
      • Configurations Service
  • API Reference
    • OpenAPI Specifications
    • 📦Changelog
      • Per-service Changelog
    • Postman Reference Collection
  • Tools
    • SDK
    • CLI
    • Control Center
  • Additional Resources
    • Resource Query Language (RQL)
    • Handling Errors
    • GitHub
    • API interaction (Python)
    • Migration guide: Enabling verification request limiting
  • ExH Platform
    • 🙋Support
    • ⏱️Usage and Performance
    • 🔓Security
    • 🗺️Regions
    • ⚖️Cloud Subscription Agreement
    • 🇺🇸CFR 21 Part 11
Powered by GitBook
On this page
  • How to use the Postman Collection
  • Step 1: Import the collection in Postman
  • Step 2: Create a Postman environment that stores your credentials
  • Step 3: Execute the authentication call

Was this helpful?

  1. API Reference

Postman Reference Collection

PreviousPer-service ChangelogNextResource Query Language (RQL)

Last updated 2 years ago

Was this helpful?

For your convenience we also provide the API specification as a Postman collection, to interact quickly and easily with the API.

You can download the collection here

How to use the Postman Collection

Step 1: Import the collection in Postman

  1. Open Postman and click on the "Import" button

  2. Select the exh-postman-collections.json from your filesystem

  3. Confirm the import by clicking the orange "Import" button

  4. The Extra Horizon postman collection is now available

Step 2: Create a Postman environment that stores your credentials

The Extra Horizon API offers oAuth1 and oAuth2 authenthication mechanisms. The Postman collection contains some logic to facilicate using the endpoints.

Create a new Postman environment that contains the following variables:

Value

baseUrl

https://api.dev.exh-sandbox.extrahorizon.io

consumerKey

27a4353c3a950a494a6fd58a6g3c0cff4affc953

consumerSecret

7470a5bc2d42346988c5418420ac27cfe6ae5e8b

email

john.doe@extrahorizon.com

password

SomeVeryDifficultP@ss

Don't forget to save the environment!

After creating the environment, make sure it is selected in the top-right dropdown before continuing.

Step 3: Execute the authentication call

Open and execute the Create OAuth1 token HTTP Request. If all environment variables are set correctly, this call will return successfully a token and tokenSecret that you should use in subsequent requests.

The token and tokenSecret variables are automatically stored in the environment. Other requests reference to these variables.

To learn more how to manage different environments, take a look at the .

Postman Documentation on Environments
124KB
exh-postman-collections.zip
archive
Import collections in Postman
Environment view in Postman