Skip to content
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

docs(connect-ui): guru connect ui docs #3251

Merged
merged 3 commits into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs-v2/integrations/all/guru.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ _No setup guide yet._

## Useful links

- [Where can I find my API key?](https://help.getguru.com/articles/cj9Rrj7i/How-to-obtain-your-API-Credentials)
- [How to obtain your API credentials](https://help.getguru.com/docs/gurus-api#:~:text=Navigate%20to%20the%20Apps%20%26%20Integrations,Token%20and%20entering%20your%20name)
- [Guru API Docs](https://developer.getguru.com/reference/authentication)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/guru.mdx)</Note>
Expand All @@ -45,3 +45,10 @@ _No setup guide yet._


<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/guru.mdx)</Note>

## Going further

<Card title="Connect to Guru" icon="link" href="/integrations/all/guru/connect" horizontal>
Guide to connect to Guru using Connect UI
</Card>

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/guru/api_token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions docs-v2/integrations/all/guru/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Guru - How do I link my account?
sidebarTitle: Guru
---


# Overview

To authenticate with Guru, you will need:
1. **User/Collection ID** - The user or collection ID of your Guru account.
2. **User/Collection Token** - The user or collection token of your Guru account.

This guide will walk you through finding the **User/Collection ID** and generating your **User/Collection Token** within Guru.

### Prerequisites:

- You must have an account with Guru.

### Instructions:

#### Step 1: Finding your User/Collection ID
a. Finding your User ID
- Your **User ID** is the username you use to sign in to your account.

b. Finding your Collection ID
- You can obtain your **Collection ID** by perfoming a curl request with your **USER ID and Token** to get a [list of all collections](https://developer.getguru.com/reference/getv1collectionsgetcollections) on your team.

```
curl -u USER:TOKEN https://api.getguru.com/api/v1/collections -D -
```

- If your credentials are correct, you will receive a list of collections along with their IDs, which you can use as your Collection ID.

#### Step 2: Generating Your User/Collection token
- There are two types of tokens for using the Guru API: a `Collection token` (read-only), and a `User token` (read/write). This guide will demonstrate how to obtain both.

a. Generating your User token
1. Login to your [Guru](https://app.getguru.com/) account.
2. Navigate to the [Apps & Integrations](https://app.getguru.com/manage/integrations/apps) page under the **Manage** menu.
<img src="/integrations/all/guru/api_integrations.png" />
3. Click on the [API Access](https://app.getguru.com/settings/integrations/api-access) tab to manage your tokens.
4. Generate an API token for yourself by selecting **Generate User Token** and entering your name. You can also generate API tokens for your teammates by selecting **Generate a new user token**.
<img src="/integrations/all/guru/generate_user_token.png" />
<img src="/integrations/all/guru/api_token.png" />
4. You can reissue a token using the **circular arrow icon** on the right side of the dashboard next to the corresponding user. You can also revoke a user's token using the **trash can icon**.

b. Generating your Collection token
1. You can also generate Collection-based read-only tokens by selecting **Generate a New Collection Token** and then selecting your desired Collection from the dropdown.
<img src="/integrations/all/guru/generate_collection_token.png" />
<img src="/integrations/all/guru/collection_token.png" />



#### Step 3: Enter credentials in the Connect UI

Once you have your **User/Collection ID** and **User/Collection Token**:
1. Open the form where you need to authenticate with Guru.
2. Enter the **User/Collection ID** and **User/Collection Token** in their respective fields.
3. Submit the form, and you should be successfully authenticated.


<img src="/integrations/all/guru/form.png" style={{maxWidth: "450px" }}/>

You are now connected to Guru.
Binary file added docs-v2/integrations/all/guru/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs-v2/snippets/generated/guru/PreBuiltTooling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| Pre-built authorization (Basic) | ✅ |
| Pre-built authorization UI | ✅ |
| Custom authorization UI | ✅ |
| End-user authorization guide | 🚫 |
| End-user authorization guide | |
| Expired credentials detection | ✅ |
</Accordion>
<Accordion title="✅ Read & write data">
Expand Down
5 changes: 5 additions & 0 deletions packages/shared/providers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3061,16 +3061,21 @@ guru:
method: GET
endpoint: /whoami
docs: https://docs.nango.dev/integrations/all/guru
docs_connect: https://docs.nango.dev/integrations/all/guru/connect
credentials:
username:
type: string
title: User/Collection ID
description: The user or collection ID of your Guru account
doc_section: '#step-1-finding-your-user-collection-id'
password:
type: string
title: User/Collection Token
description: The user or collection token of your Guru account
secret: true
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
doc_section: '#step-2-generating-your-user-collection-token'

github:
display_name: GitHub
Expand Down
Loading