In this guide, we will show you how to easily get started using the StackOne Unified API. Let's get started with some terminology:

Project: this is the construct that binds all of your StackOne integrations together and where your credentials for each Provider integration are stored.

StackOne API Key: this is the API key that you will use to authenticate for all calls to StackOne.

Provider: a company with a SaaS offering in any of our supported verticals such as HRIS, ATS, CRM, etc

The overall model can be summarised in the following diagram:

There are 4 steps to setup your first integration:

The rest of this document will walk you through the process of configuring your first StackOne integration.

Making your first StackOne API request

Create a project

To create a Project, navigate to the StackOne Dashboard and select New Project in the top-left dropdown. Give your Project a name and select the most local geographic region that your traffic will come from.

Click the blue Create Project button to continue.

📘

Projects support multiple integrations so if you have already created a Project you can skip this step and reuse an existing Project.

Configure an Integration

In this step, we will configure an Integration for your Project. This involves working with one of our Providers to set up your sandbox account and credentials with them before storing those credentials in your Project and activating them in a process we call Account Linking.

Each of our Providers follows a slightly different process for setting up the integration so we have documented them all here:

      StackOne Connection Guides

Please follow the detailed process described for your desired Provider and then return to this page.

For our example, we will enable an integration with BambooHR.

📘

You can get a free bamboohr trial account or request temporary access to a StackOne sandbox account

From the dashboard, click on the Integrations menu in the left-navigation and you will see several tabs, each of which contains our available partner integrations for that vertical.

Refer to Managing Integrations and enable any integration you have a test or sandbox account for (contact StackOne's support if you do not have any sandbox account available).

The final step is to link your sandbox BambooHR account with your project. To do this, click on Accounts in the left-navigation and then on Link Account button on the top-right or by creating an auth link.

You will be presented with the StackOne hub with the a list of enabled integrations - enter details of the sandbox account to connect it.

After successfully connecting a linked account, you will now see in your Accounts you should now also see the BambooHR provider is listed as Active.

Refer to the Managing Linked Accounts documentation for more details around actions you can take with any linked accounts (such as making test requests via the request tester interface).

Get a StackOne API Key

The next step is to create a StackOne API Key for your project. To do this, click on API Keys in the left navigation and click the Create API Key button.

🔑

This API key will allow you to interact with any admin and unified endpoints documented in the API Reference

In the side-panel, give your key a descriptive name. This name is only used as a label for your key but cannot be changed later.

When you click Generate, your StackOne API Key will be generated and displayed on-screen as shown:

Copy and save the StackOne API Key securely.

🚧

This is the only time that the StackOne API Key will be displayed in its entirety and it cannot be retrieved in future, even by StackOne support staff. If you lose this key you will need to generate another key.

Now that you have successfully created a Project and a StackOne API Key to connect to your project. You can now use the API key by pasting it as either the username or password of the basic authentication in any endpoints documented in the API reference (eg: List Accounts).