-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(integrations): add support for humaans-io #6727
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| --- | ||
| title: 'Humaans.io' | ||
| sidebarTitle: 'Humaans.io' | ||
| description: 'Integrate your application with the Humaans.io API' | ||
| --- | ||
|
|
||
| ## 🚀 Quickstart | ||
|
|
||
| Connect to Humaans.io with Nango and see data flow in 2 minutes. | ||
|
|
||
| <Steps> | ||
| <Step title="Create the integration"> | ||
| In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> _Configure New Integration_ -> _Humaans.io_. | ||
| </Step> | ||
| <Step title="Authorize Humaans.io"> | ||
| Go to [Connections](https://app.nango.dev/dev/connections) -> _Add Test Connection_ -> _Authorize_, then enter your Humaans.io API access token. Later, you'll let your users do the same directly from your app. | ||
| </Step> | ||
| <Step title="Call the Humaans.io API"> | ||
| Let's make your first request to the Humaans.io API (get the authenticated user's profile, but requires the `private.read` or `public.read` scopes). Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections): | ||
| <Tabs> | ||
| <Tab title="cURL"> | ||
|
|
||
| ```bash | ||
| curl "https://api.nango.dev/proxy/me" \ | ||
| -H "Authorization: Bearer <NANGO-SECRET-KEY>" \ | ||
| -H "Provider-Config-Key: <INTEGRATION-ID>" \ | ||
| -H "Connection-Id: <CONNECTION-ID>" | ||
| ``` | ||
|
|
||
| </Tab> | ||
|
|
||
| <Tab title="Node"> | ||
|
|
||
| Install Nango's backend SDK with `npm i @nangohq/node`. Then run: | ||
|
|
||
| ```typescript | ||
| import { Nango } from '@nangohq/node'; | ||
|
|
||
| const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' }); | ||
|
|
||
| const res = await nango.get({ | ||
| endpoint: '/me', | ||
| providerConfigKey: '<INTEGRATION-ID>', | ||
| connectionId: '<CONNECTION-ID>' | ||
| }); | ||
|
|
||
| console.log(res.data); | ||
| ``` | ||
| </Tab> | ||
|
|
||
| </Tabs> | ||
| Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get). | ||
|
|
||
| ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests. | ||
| </Step> | ||
|
|
||
| <Step title="Implement Nango in your app"> | ||
| Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app. | ||
|
|
||
| To obtain your own production credentials, follow the setup guide linked below. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| ## 📚 Humaans.io Integration Guides | ||
|
|
||
| Nango-maintained guides for common use cases. | ||
|
|
||
| - [How do I link my Humaans.io account?](/api-integrations/humaans-io/connect) | ||
| Connect your Humaans.io account using the Connect UI | ||
|
|
||
| Official docs: [Humaans.io API docs](https://docs.humaans.io/api/) | ||
|
|
||
| ## 🧩 Pre-built syncs & actions for Humaans.io | ||
|
|
||
| Enable them in your dashboard. Extend and customize to fit your needs. | ||
|
|
||
| import PreBuiltUseCases from "/snippets/generated/humaans-io/PreBuiltUseCases.mdx" | ||
|
|
||
| <PreBuiltUseCases /> | ||
|
|
||
| --- | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: Humaans.io - How do I link my account? | ||
| sidebarTitle: Humaans.io | ||
| --- | ||
|
|
||
| # Overview | ||
|
|
||
| To authenticate with Humaans.io, you will need: | ||
| 1. **API Access Token** - A token that grants secure access to the Humaans.io API, scoped to the permissions you select when creating it. | ||
|
|
||
| This guide will walk you through generating your **API Access Token** in Humaans.io. | ||
|
|
||
| ### Prerequisites: | ||
|
|
||
| - You must have a Humaans.io account with a role that can create API access tokens (Owner, Admin, Finance, or Tech). | ||
|
|
||
| ### Instructions: | ||
|
|
||
| #### Step 1: Generating your API access token | ||
|
|
||
| 1. Log in to your Humaans.io account. | ||
| 2. Click the arrows next to your name in the top left corner, then click **API access tokens**. | ||
| 3. Click **Generate new token**. | ||
| 4. Enter a name for your token, then select the [scopes](https://docs.humaans.io/api/#scopes) it needs (e.g. `public:read`, `private:read`, `private:write`, `compensations:read`, `compensations:write`, `documents:read`, `documents:write`, `webhooks:manage`). | ||
| 5. Click the **Click to copy** button next to your new token to copy it. Humaans.io only shows the token once, so store it securely. | ||
|
|
||
| <Note> | ||
| The token inherits the permissions of the role of the user who created it, in addition to the selected scopes. For example, a token created by a `user` role can only ever access that user's own profile, even with `private:read` selected. | ||
| </Note> | ||
|
|
||
| #### Step 2: Enter credentials in the Connect UI | ||
|
|
||
| Once you have your **API Access Token**: | ||
|
|
||
| 1. Open the form where you need to authenticate with Humaans.io. | ||
| 2. Enter your **API Access Token** in the field provided. | ||
| 3. Submit the form, and you should be successfully authenticated. | ||
|
|
||
| You are now connected to Humaans.io. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| _No pre-built syncs or actions available yet._ | ||
|
|
||
| <Tip>Not seeing the integration you need? [Build your own](/guides/functions/functions-guide) independently.</Tip> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.