Getting Started

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

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 contact form.

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 app.extrahorizon.com, 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

The Extra Horizon CLI 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 CLI Documentation for more information and examples.

Use the JavaScript SDK

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

Visit the SDK Documentation for more information and examples.

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.

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

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

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.

Data Service

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.

Task Service

Documentation and Support

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

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

Last updated