Nango

https://nango.dev/docs
Admin
Nango is a platform that authorizes and manages API access on behalf of customers, providing API...
Tokens:1,647,994
Snippets:13,267
Trust Score:8.5
Update:1 day ago
Show doc for...
Tokens:
Raw
### Go example to get a connection

Source: https://nango.dev/docs/reference/backend/http-api/connections/get

Uses the net/http package to perform a GET request and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/connections/{connectionId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go: Get a function

Source: https://nango.dev/docs/reference/backend/http-api/functions/get

Go example using the net/http package to make the GET request. It sets the Authorization header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/integrations/{uniqueKey}/functions/{name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Launch the sample app

Source: https://nango.dev/docs/getting-started/use-cases/sample-app

Starts the sample app, which can then be accessed at http://localhost:3011.

```bash
npm run start
```

--------------------------------

### Node.js SDK example to fetch Tailscale users

Source: https://nango.dev/docs/integrations/all/tailscale-api-key

Install Nango's backend SDK with `npm i @nangohq/node` before running this example. It uses the Nango Node SDK to make a GET request to the Tailscale API, replacing placeholders with your API key, integration ID, and connection ID.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
  endpoint: '/v2/tailnet/{connectionConfig.organizationName}/users',
  providerConfigKey: '<INTEGRATION-ID>',
  connectionId: '<CONNECTION-ID>'
});

console.log(res.data.users);
```

--------------------------------

### Node.js SDK example to get Google Health identity

Source: https://nango.dev/docs/api-integrations/google-health

Install Nango's backend SDK with `npm i @nangohq/node` and run this code to fetch the Google Health identity for the authorized user. Replace placeholders with your credentials.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/v4/users/me/identity',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```

--------------------------------

### Node SDK example to fetch sites from Google Search Console

Source: https://nango.dev/docs/api-integrations/google-search-console

Install Nango's backend SDK with `npm i @nangohq/node`, then run this code to fetch a list of sites. Replace the placeholders with your API key, integration ID, and connection ID.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/v3/sites',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

    console.log(JSON.stringify(res.data, 2, null));
```

--------------------------------

### Node SDK example to list workspaces

Source: https://nango.dev/docs/api-integrations/zero

Install Nango's backend SDK with 'npm i @nangohq/node' before running this code. It uses the Nango Node SDK to make a GET request to the Zero API endpoint '/api/workspaces' with parameters. Replace the placeholders with your credentials.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/api/workspaces',
    params: { fields: 'id,name' },
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```

--------------------------------

### Install Nango CLI and initialize integrations

Source: https://nango.dev/docs/getting-started/use-cases/sample-app

Installs the Nango CLI globally and initializes the nango-integrations directory.

```bash
npm install -g nango
cd nango-integrations/
nango init
```

--------------------------------

### Node SDK example to list Phrase projects

Source: https://nango.dev/docs/api-integrations/phrase

Install Nango's backend SDK with `npm i @nangohq/node`, then run this code to fetch projects from Phrase. Replace placeholders with your Nango API key, integration ID, and connection ID.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/v2/projects',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```

--------------------------------

### Node.js SDK example to fetch team info from Heymarket API

Source: https://nango.dev/docs/api-integrations/heymarket

Install Nango's backend SDK with 'npm i @nangohq/node' before running this code. It uses the Nango instance to make a GET request to '/v1/team' with the provided configuration. The response is logged as a JSON string.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/v1/team',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(JSON.stringify(res.data, null, 2));
```

--------------------------------

### Node SDK example to geocode an address

Source: https://nango.dev/docs/api-integrations/google-maps

Install Nango's backend SDK with `npm i @nangohq/node`, then run this code to make a GET request to the Google Maps geocoding API. Replace placeholders with your Nango API key, integration ID, and connection ID.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/maps/api/geocode/json',
    params: { address: '1600 Amphitheatre Parkway, Mountain View, CA' },
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```

--------------------------------

### Initialize integrations folder with nango init

Source: https://nango.dev/docs/guides/functions/functions-guide

Creates a `nango-integrations/` folder with example configuration. The `.nango` subdirectory must be committed because the CLI uses it to track deployed state.

```bash
nango init nango-integrations
```

--------------------------------

### Node SDK example to fetch current user from Greenhouse API

Source: https://nango.dev/docs/integrations/all/greenhouse

Install the Nango Node SDK with `npm i @nangohq/node` before running this code. It initializes the Nango client with your API key and makes a GET request to the Greenhouse endpoint /v1/partner/current_user. Replace the placeholders with your actual credentials.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
  endpoint: '/v1/partner/current_user',
  providerConfigKey: '<INTEGRATION-ID>',
  connectionId: '<CONNECTION-ID>'
});

console.log(JSON.stringify(res.data, null, 2));
```

--------------------------------

### Install free self-hosted Nango on a VM

Source: https://nango.dev/docs/guides/platform/self-hosting/self-hosting

Commands to create a directory, download the docker-compose.yaml, and start Nango with Docker Compose.

```bash
mkdir nango && cd nango
wget https://raw.githubusercontent.com/NangoHQ/nango/master/docker-compose.yaml
docker-compose up -d
```

--------------------------------

### GET /records response example

Source: https://nango.dev/docs/guides/functions/syncs/records-cache

Example JSON response from the GET /records endpoint showing a stream of record changes with metadata and a next_cursor for pagination. Use the filter query parameter to filter by last_action (added, updated, deleted).

```json
{
    "records": [
        {
            "id": "contact-1",
            "name": "Alice",
            "_nango_metadata": {
                "first_seen_at": "2024-01-15T10:00:00.000Z",
                "last_modified_at": "2024-01-15T10:00:00.000Z",
                "last_action": "ADDED",
                "deleted_at": null,
                "cursor": "MjAyNC0wMS0xNVQxMDowMDowMC..."
            }
        },
        {
            "id": "contact-2",
            "name": "Bob (updated)",
            "_nango_metadata": {
                "first_seen_at": "2024-01-10T08:00:00.000Z",
                "last_modified_at": "2024-01-15T10:05:00.000Z",
                "last_action": "UPDATED",
                "deleted_at": null,
                "cursor": "MjAyNC0wMS0xNVQxMDowNTowMC..."
            }
        }
    ],
    "next_cursor": "MjAyNC0wMS0xNVQxMDowNTowMC..."
}
```

--------------------------------

### Node SDK example to list organization devices

Source: https://nango.dev/docs/api-integrations/apple-business-manager

Install Nango's backend SDK with 'npm i @nangohq/node' and run this code to fetch organization devices. Replace the placeholders with your Nango API key, integration ID, and connection ID.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/v1/orgDevices',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```

--------------------------------

### Ruby example to get a connection

Source: https://nango.dev/docs/reference/backend/http-api/connections/get

Uses Net::HTTP to perform a GET request with SSL and prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.nango.dev/connections/{connectionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Node.js: List Paddle products using Nango SDK

Source: https://nango.dev/docs/api-integrations/paddle

Install the Nango backend SDK with `npm i @nangohq/node`, then run this code to fetch products from Paddle. Replace placeholders with your Nango API key, integration ID, and connection ID.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/products',
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(res.data);
```

--------------------------------

### Node.js: Fetch products using Nango SDK

Source: https://nango.dev/docs/api-integrations/lightspeed-retail

Install the Nango backend SDK with `npm i @nangohq/node` and run this script to fetch products. Replace placeholders with your Nango API key, integration ID, and connection ID.

```javascript
import { Nango } from '@nangohq/node';

const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });

const res = await nango.get({
    endpoint: '/api/2.0/products',
    params: {
      page_size: 10
    },
    providerConfigKey: '<INTEGRATION-ID>',
    connectionId: '<CONNECTION-ID>'
});

console.log(JSON.stringify(res.data, null, 2));
```

--------------------------------

### Java Unirest example to get a connection

Source: https://nango.dev/docs/reference/backend/http-api/connections/get

Uses the Unirest library to perform a GET request and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://api.nango.dev/connections/{connectionId}")
  .header("Authorization", "Bearer <token>")
  .asString();
```

--------------------------------

### Python requests example to get a connection

Source: https://nango.dev/docs/reference/backend/http-api/connections/get

Uses the requests library to perform a GET request. Prints the response text.

```python
import requests

url = "https://api.nango.dev/connections/{connectionId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Go: Start a sync

Source: https://nango.dev/docs/reference/backend/http-api/sync/start

Uses net/http to POST the sync start payload. Reads and prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/sync/start"

	payload := strings.NewReader("{\n  \"provider_config_key\": \"<string>\",\n  \"syncs\": [\n    \"github-issues\"\n  ],\n  \"connection_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### Go example for creating a connect session

Source: https://nango.dev/docs/reference/backend/http-api/connect/sessions/create

Uses net/http to POST the session payload. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nango.dev/connect/sessions"

	payload := strings.NewReader("{\n  \"tags\": {},\n  \"allowed_integrations\": [\n    \"<string>\"\n  ],\n  \"integrations_config_defaults\": {},\n  \"overrides\": {},\n  \"webhook_url_override\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```
Tokens:
Raw