Create a consumer access token

curl --request POST \
  --url https://{brand}.extole.io/api/v5/token \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "duration_seconds": 123,
  "email": "<string>",
  "jwt": "<string>"
}
'

import requests

url = "https://{brand}.extole.io/api/v5/token"

payload = {
    "duration_seconds": 123,
    "email": "<string>",
    "jwt": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({duration_seconds: 123, email: '<string>', jwt: '<string>'})
};

fetch('https://{brand}.extole.io/api/v5/token', 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://{brand}.extole.io/api/v5/token",
  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([
    'duration_seconds' => 123,
    'email' => '<string>',
    'jwt' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://{brand}.extole.io/api/v5/token"

	payload := strings.NewReader("{\n  \"duration_seconds\": 123,\n  \"email\": \"<string>\",\n  \"jwt\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<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://{brand}.extole.io/api/v5/token")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"duration_seconds\": 123,\n  \"email\": \"<string>\",\n  \"jwt\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{brand}.extole.io/api/v5/token")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"duration_seconds\": 123,\n  \"email\": \"<string>\",\n  \"jwt\": \"<string>\"\n}"

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

{
  "access_token": "<string>",
  "expires_in": 123,
  "scopes": []
}

POST

api

token

Create a consumer access token

curl --request POST \
  --url https://{brand}.extole.io/api/v5/token \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "duration_seconds": 123,
  "email": "<string>",
  "jwt": "<string>"
}
'

import requests

url = "https://{brand}.extole.io/api/v5/token"

payload = {
    "duration_seconds": 123,
    "email": "<string>",
    "jwt": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({duration_seconds: 123, email: '<string>', jwt: '<string>'})
};

fetch('https://{brand}.extole.io/api/v5/token', 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://{brand}.extole.io/api/v5/token",
  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([
    'duration_seconds' => 123,
    'email' => '<string>',
    'jwt' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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://{brand}.extole.io/api/v5/token"

	payload := strings.NewReader("{\n  \"duration_seconds\": 123,\n  \"email\": \"<string>\",\n  \"jwt\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<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://{brand}.extole.io/api/v5/token")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"duration_seconds\": 123,\n  \"email\": \"<string>\",\n  \"jwt\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{brand}.extole.io/api/v5/token")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"duration_seconds\": 123,\n  \"email\": \"<string>\",\n  \"jwt\": \"<string>\"\n}"

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

{
  "access_token": "<string>",
  "expires_in": 123,
  "scopes": []
}

Authorizations

Authorization

string

header

required

Body

duration_seconds

integer<int64> | null

required

Requested token lifetime in seconds. Defaults to the client configuration value when omitted.

string | null

required

Email address used to identify or create the consumer. Ignored when jwt is present.

jwt

string | null

required

Signed JWT carrying consumer identity claims. When supplied, identity is derived from the token claims rather than from email.

Response

Created consumer access token.

access_token

string

required

Opaque access token for the consumer session. Pass as a Bearer token or access_token query parameter on subsequent requests.

expires_in

integer<int64>

required

Seconds until the token expires.

scopes

enum<string>[]

required

Set of permission scopes granted to this token.

Available options:

UPDATE_PROFILE,

VERIFIED_CONSUMER

Get consumer token details Delete a consumer access token

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Create a consumer access token

Authorizations

Body

Response