curl --request POST \
--url https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"expires_in_seconds": 2,
"connector_config_fields": "<unknown>"
}
'import requests
url = "https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/"
payload = {
"expires_in_seconds": 2,
"connector_config_fields": "<unknown>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({expires_in_seconds: 2, connector_config_fields: '<unknown>'})
};
fetch('https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expires_in_seconds' => 2,
'connector_config_fields' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/"
payload := strings.NewReader("{\n \"expires_in_seconds\": 2,\n \"connector_config_fields\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expires_in_seconds\": 2,\n \"connector_config_fields\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expires_in_seconds\": 2,\n \"connector_config_fields\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"connector_config_fields": "<unknown>"
}Create Setup Token
Setup links for a connection, so a third party fills in credentials in their own browser.
Create one to get a token, then send its recipient to {WEB_APP_URL}/lcl/{token}: they
configure the connection without a Nekt account, and the credentials never pass through
you. Optionally restrict what the link exposes with connector_config_fields, and have
the connection announce completion with its callback_webhook.
The token is returned in clear text only when it is created, and is redacted on every later read. Managing setup links requires manager access on the connection — the token is a config-write capability, so listing links is as sensitive as creating one.
curl --request POST \
--url https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"expires_in_seconds": 2,
"connector_config_fields": "<unknown>"
}
'import requests
url = "https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/"
payload = {
"expires_in_seconds": 2,
"connector_config_fields": "<unknown>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({expires_in_seconds: 2, connector_config_fields: '<unknown>'})
};
fetch('https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expires_in_seconds' => 2,
'connector_config_fields' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/"
payload := strings.NewReader("{\n \"expires_in_seconds\": 2,\n \"connector_config_fields\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"expires_in_seconds\": 2,\n \"connector_config_fields\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/live-connections/{live_connection_slug}/setup-tokens/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expires_in_seconds\": 2,\n \"connector_config_fields\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"token": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"connector_config_fields": "<unknown>"
}Authorizations
API Key authentication. Format: 'x-api-key: api_key'
Path Parameters
The slug of the live connection
Body
A time-limited link that lets someone without a Nekt account configure this connection.
x >= 1Restricts which connector config fields are visible/editable through this setup link. Same shape as the config: true/false, a list of field names, or a nested object. NULL means no restriction (the whole config template).
Response
A time-limited link that lets someone without a Nekt account configure this connection.
Restricts which connector config fields are visible/editable through this setup link. Same shape as the config: true/false, a list of field names, or a nested object. NULL means no restriction (the whole config template).
Was this page helpful?