Getting started

Overview

Learn the Basics

Core conceptsWorkspacesApplications

Verify

Quickstart

Core concepts

Explains some of the basic terminology we use here at Hive.

We will walk through the initial steps of getting started using Hive to familiarize you with some of the key concepts.

This article uses an example to introduce core concepts of Hive: workspaces, applications, and products. If you already know what these are in the context of Hive, you can safely skip reading it.

We will use a simple example to help describe some of the steps involved: A company named ACME Corp wants to use Hive for identity verification. They have a web app, and they want to verify the identity of their users.

Set up a Hive account

If you haven't already signed up for a Hive account, you can do so here - it's free.

Workspaces

A workspace is a group of applications that can be administered together. Workspaces let you collaborate with team members, add permissions, and share applications across your whole team using a shared billing account.

When you first log in to your Hive account, you can create a new workspace, or use the existing workspace created for you.

Workspace administrators set up and maintain the organization’s workspace settings, which include:

  • incident contacts - the people who get notified in the event of an outage or incident
  • the Workspace name and slug - the display name and namespace of the workspace in the Hive system

Workspace characteristics:

  1. The Workspace name has to be unique.
  2. The Workspace name can contain only lowercase alphanumeric characters and hyphens ("-"). It cannot begin or end with a hyphen.
  3. The Workspace name must be a minimum of 3 characters and maximum of 64 characters.
  4. The Workspace name cannot be changed after creation.

You can create additional Workspaces at any time.

When you create your Workspace, you are asked for the region you want to use. This choice affects where your data will be hosted.

In our example, ACME Corp picked the name ACME EU and Europe as their region.

Applications

Now that you have a workspace, we need to know about your app(s) that will be using our services.

In Hive, you create an application (or more than one!) for each website or app you want to integrate. While it’s not required that you have a single Application for each site or app, we highly recommend creating an Application for each unique source, e.g. for iOS app, for Android app and for Website.

When you create an application in the Hive Dashboard, the first piece of information we ask for is its type. This can be one of the following:

  • Web
  • iOS
  • Android

In our example, ACME Corp has a web application, hence they would create an Application of type Web.

Products

Now that you have set up your Application, you are ready to configure Products to be used by the Application.

Each Product can be shared among multiple applications. You can choose which of them to enable for each Application.

In our example, ACME Corp wants to verify the identity of their users, hence they would choose Hive Verify.

GuideAPI ReferenceGitHubTwitter