Generate a link token for authentication in subsequent steps to a unique user ID.
curl --request POST \
--url https://api.sandbox.goteal.co/user-tokens \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"user_id": "95a0e70b-fe02-4f47-aef9-2efff279df71"
}
'import requests
url = "https://api.sandbox.goteal.co/user-tokens"
payload = { "user_id": "95a0e70b-fe02-4f47-aef9-2efff279df71" }
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({user_id: '95a0e70b-fe02-4f47-aef9-2efff279df71'})
};
fetch('https://api.sandbox.goteal.co/user-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.sandbox.goteal.co/user-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([
'user_id' => '95a0e70b-fe02-4f47-aef9-2efff279df71'
]),
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.sandbox.goteal.co/user-tokens"
payload := strings.NewReader("{\n \"user_id\": \"95a0e70b-fe02-4f47-aef9-2efff279df71\"\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.sandbox.goteal.co/user-tokens")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"95a0e70b-fe02-4f47-aef9-2efff279df71\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.goteal.co/user-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 \"user_id\": \"95a0e70b-fe02-4f47-aef9-2efff279df71\"\n}"
response = http.request(request)
puts response.read_body{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiOTVhMGU3MGItZmUwMi00ZjQ3LWFlZjktMmVmZmYyNzlkZjcxIiwiaWF0IjoxNTE2MjM5MDIyfQ.4S5J",
"webapp_link": "https://api.sandbox.goteal.co/r/ZwgQkNEMZ4QDkQ",
"created_at": "2019-05-17T00:00:00.000Z"
}{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}User Token
Generate User token
POST
/
user-tokens
Generate a link token for authentication in subsequent steps to a unique user ID.
curl --request POST \
--url https://api.sandbox.goteal.co/user-tokens \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"user_id": "95a0e70b-fe02-4f47-aef9-2efff279df71"
}
'import requests
url = "https://api.sandbox.goteal.co/user-tokens"
payload = { "user_id": "95a0e70b-fe02-4f47-aef9-2efff279df71" }
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({user_id: '95a0e70b-fe02-4f47-aef9-2efff279df71'})
};
fetch('https://api.sandbox.goteal.co/user-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.sandbox.goteal.co/user-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([
'user_id' => '95a0e70b-fe02-4f47-aef9-2efff279df71'
]),
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.sandbox.goteal.co/user-tokens"
payload := strings.NewReader("{\n \"user_id\": \"95a0e70b-fe02-4f47-aef9-2efff279df71\"\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.sandbox.goteal.co/user-tokens")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"95a0e70b-fe02-4f47-aef9-2efff279df71\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.goteal.co/user-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 \"user_id\": \"95a0e70b-fe02-4f47-aef9-2efff279df71\"\n}"
response = http.request(request)
puts response.read_body{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiOTVhMGU3MGItZmUwMi00ZjQ3LWFlZjktMmVmZmYyNzlkZjcxIiwiaWF0IjoxNTE2MjM5MDIyfQ.4S5J",
"webapp_link": "https://api.sandbox.goteal.co/r/ZwgQkNEMZ4QDkQ",
"created_at": "2019-05-17T00:00:00.000Z"
}{
"errors": [
"No X-API-KEY header provided or wrong value"
]
}Authorizations
ApiKeyAuthMemberBearerAuth
Body
application/json
The id of the user
Example:
"95a0e70b-fe02-4f47-aef9-2efff279df71"
Response
Created
The token to be used in subsequent requests
Example:
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiOTVhMGU3MGItZmUwMi00ZjQ3LWFlZjktMmVmZmYyNzlkZjcxIiwiaWF0IjoxNTE2MjM5MDIyfQ.4S5J"
URL of the teal webapp with short version of token. Ignore if not utilising webapp.
Example:
"https://api.sandbox.goteal.co/r/ZwgQkNEMZ4QDkQ"
Example:
"2019-05-17T00:00:00.000Z"
⌘I