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
  • Access to Your Environment
  • Use the Web-based Interface
  • Use the CLI Tool
  • Use the JavaScript SDK
  • Use the REST API
  • Start Building Your Medical Backend
  • Add Additional Users and Roles
  • Create Your First Data Schema
  • Create Your First Function
  • Documentation and Support

Was this helpful?

Getting Started

This page provides the resources to start building your application on Extra Horizon (ExH).

PreviousExtra Horizon DocumentationNextStart familiarizing yourself

Last updated 11 months ago

Was this helpful?

This getting started guide assumes you received credentials for an Extra Horizon environment. If you don't have credentials yet, get in touch via our .

Access to Your Environment

Once your dedicated environment is set up, you will receive the information and credentials to connect to your environment:

Variable
Example

HOST

api.customer.extrahorizon.io

OAUTH_CONSUMER_KEY

bb6c5186acf8aca8ed64ef4ef49e08bb4484c7c4

OAUTH_CONSUMER_SECRET

4808fbc315294aa7aeb2e40b76d84680c0b582ee

e-mail

john.doe@extrahorizon.com

password

SomeDiff!UnguessableP8ssword

If you received credentials to access the sandbox environment, please be aware that this is a shared environment only for testing purposes. Other sandbox users can view and modify your data. Do not store any sensitive or PII data in the sandbox environment.

Once you have the credentials, there are multiple methods to access your environment.

Use the Web-based Interface

The web-based ExH Control Center interface, available at , is the easiest way to get familiar with your ExH environment. Through this interface, you can:

  • Create and manage users

  • View existing data schemas and their properties

  • Query the data in the data service

  • View functions, task executions and task execution logs

Use the CLI Tool

Use the JavaScript SDK

Use the REST API

The above mentioned methods to access your Extra Horizon environment all make use of the REST API. It is an HTTP interface to your environment and it uses standard HTTP headers and status codes.

Start Building Your Medical Backend

Add Additional Users and Roles

  1. Login with the admin credentials that you received

  2. Under the "Services" section, select "Users"

  3. You can now add new users and assign the appropriate roles to them

Create Your First Data Schema

The first step in building your application is to create one or more data schema's that define the type of data you want to store.

Take a look at the Data Service documentation. There you can also find an instructional video that walks you through the steps of creating a data schema.

Create Your First Function

After defining and creating data schema's, the next step is to build the business logic. In Extra Horizon, business logic is implemented in Functions.

Documentation and Support

Take a look at these resources for more information on how to build on Extra Horizon:

The is an open-source tool to manage your environment through the command line. You can also use this tool to automate certain actions through scripts and CI/CD pipelines.

Visit the for more information and examples.

The offers first-class TypeScript support and makes it easy to interface with your environment from code.

Visit the for more information and examples.

Visit the to learn more about all the endpoints available in your ExH environment.

To quickly get started with the REST API, we also provide a .

Navigate to

The website

The GitHub repository

The YouTube playlist, which contains short instructional videos on how the different services can be used.

Our to quickly get started with the REST API.

If you can't find the answers to your questions, reach out to our support team at .

contact form
app.extrahorizon.com
Extra Horizon CLI
CLI Documentation
JavaScript SDK
SDK Documentation
OpenAPI specifications
Postman Reference Collection
https://app.extrahorizon.com
Data Service
Task Service
docs.extrahorizon.com
ExtraHorizon/examples
Extra Horizon 101
Postman Reference Collection
support@extrahorizon.com
Login screen of the ExH Control Center
Manage your environment using the ExH CLI