Welcome to Human API!
We've provided some guides to help get you up and running as quickly as possible, and we're excited to have you on board. What follows is a technical explanation of the Human API integration process. For a higher-level view, check out What is Human API?
Human API has two main components:
- Connect - UI to facilitate data source connections
- Data API - Endpoints to pull user data from
To quickly grasp how an integration with Human API works, it is helpful to view the following diagram:
In the diagram, you'll see your application and server in orange, Human API's components and actions in blue, and all external data sources the user is trying to connect to in gray.
The flow here is simple:
A: A user of your application launches Human Connect to connect a data source
B: In Human Connect, they search for/select available data source(s) to connect to your application
C: When they are finished, Connect notifies our system of the connected accounts
D: Our system begins syncing their data from the source
E: Your server retrieves user credentials and data from Human API
Once a user has an active connection, we will continue to sync new data for that user and make it available to you. Most importantly, no matter what or how many sources the user connects, you'll end up with a single set of Human API credentials and one, normalized API to query all of that user's data.
There are two main components of integrating Human API:
- Adding Human Connect to your application (Client Side)
- Retrieving a user's API Credentials (Server Side)
- Retrieving the user's data from the Data API
Let's get started!
Setting Up Your Access Credentials
First, you'll need to sign up for a developer account.
After signing up, the first thing you'll want to do is create a Human API application. An application in Human API is a container that holds users and their data, and allows for custom configuration options. Above all, it is the single pipeline that you will integrate directly with your application.
Each application has a specific set of keys found on the application's settings page that you'll need for development, as described below:
|Client ID||Unique ID of the application container|
|Client Secret||Secret value for the application container|
|App Key||Authentication token for the Application API|
Your Client Secret and App Key should be kept securely on your server. For support requests, please send along your Client ID only.
Now that you have access credentials through the Developer Portal, everything is in place to start the integration.
Next up, integrating Human Connect!
Updated almost 2 years ago