API DQE One — Autenticación y sesión

Autenticación y sesión - API DQE One

Estos tres endpoints emiten y gestionan las credenciales que el paquete DQE One para Salesforce utiliza para llamar al resto de la API One: un token de proceso de corta duración, un flujo de suscripción (incorporación) de organización/usuario, y un token de sesión para la interfaz personalizada del paquete.

Documentación relacionada:

API DQE One — Introducción (resumen del modelo de autenticación, comprobación de disponibilidad)

Jump to getOAuthTokenForProcess subscribe createTokenSession

Token de proceso - API DQE One

Emite un token de corta duración utilizado para autenticar un proceso backend específico iniciado por el paquete de Salesforce.

getOAuthTokenForProcess

Jump to Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envía un cuerpo JSON a este endpoint con la cabecera DQE-Authorization configurada.

{DOMAIN} es el dominio del servidor donde está instalada la instancia propia del backend de DQE One de tu organización — dado que este backend se ejecuta en tu propia infraestructura, este valor lo determina tu despliegue, no lo emite DQE. {DQE_AUTHORIZATION_KEY} es proporcionado por DQE al configurar la cuenta/el paquete; contacta con tu gestor de cuenta de DQE para obtenerlo.

POSThttps://{DOMAIN}/getOAuthTokenForProcess

Ejemplos de código

Solicitar un token de proceso

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/getOAuthTokenForProcess" \
  -H "DQE-Authorization: {DQE_AUTHORIZATION_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "00D5e0000008abcEAA",
  "crt": "2026-10-28T10:15:00Z",
  "sub": "0055e00000AbCnoFAF",
  "aud": "dqe-unify-api",
  "urllogin": "https://login.salesforce.com"
}'

fetch("https://{DOMAIN}/getOAuthTokenForProcess", {
  method: "POST",
  headers: {
    "DQE-Authorization": "{DQE_AUTHORIZATION_KEY}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    orgId: "00D5e0000008abcEAA",
    crt: "2026-10-28T10:15:00Z",
    sub: "0055e00000AbCnoFAF",
    aud: "dqe-unify-api",
    urllogin: "https://login.salesforce.com"
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/getOAuthTokenForProcess",
    headers={
        "DQE-Authorization": "{DQE_AUTHORIZATION_KEY}",
    },
    json={
        "orgId": "00D5e0000008abcEAA",
        "crt": "2026-10-28T10:15:00Z",
        "sub": "0055e00000AbCnoFAF",
        "aud": "dqe-unify-api",
        "urllogin": "https://login.salesforce.com",
    },
)
print(response.json())

<?php
$data = [
    'orgId' => '00D5e0000008abcEAA',
    'crt' => '2026-10-28T10:15:00Z',
    'sub' => '0055e00000AbCnoFAF',
    'aud' => 'dqe-unify-api',
    'urllogin' => 'https://login.salesforce.com',
];

$ch = curl_init("https://{DOMAIN}/getOAuthTokenForProcess");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'DQE-Authorization: {DQE_AUTHORIZATION_KEY}',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

const axios = require('axios');

axios.post('https://{DOMAIN}/getOAuthTokenForProcess', {
  orgId: '00D5e0000008abcEAA',
  crt: '2026-10-28T10:15:00Z',
  sub: '0055e00000AbCnoFAF',
  aud: 'dqe-unify-api',
  urllogin: 'https://login.salesforce.com'
}, {
  headers: {
    'DQE-Authorization': '{DQE_AUTHORIZATION_KEY}',
    'Content-Type': 'application/json'
  }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"orgId\":\"00D5e0000008abcEAA\",\"crt\":\"2026-10-28T10:15:00Z\",\"sub\":\"0055e00000AbCnoFAF\",\"aud\":\"dqe-unify-api\",\"urllogin\":\"https://login.salesforce.com\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/getOAuthTokenForProcess"))
    .header("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();

var json = "{\"orgId\":\"00D5e0000008abcEAA\",\"crt\":\"2026-10-28T10:15:00Z\",\"sub\":\"0055e00000AbCnoFAF\",\"aud\":\"dqe-unify-api\",\"urllogin\":\"https://login.salesforce.com\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://{DOMAIN}/getOAuthTokenForProcess");
request.Headers.Add("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}");
request.Content = content;

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

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

func main() {
    body := []byte(`{"orgId":"00D5e0000008abcEAA","crt":"2026-10-28T10:15:00Z","sub":"0055e00000AbCnoFAF","aud":"dqe-unify-api","urllogin":"https://login.salesforce.com"}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/getOAuthTokenForProcess", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parámetros

Todos los campos se envían como un único cuerpo de solicitud JSON.

Nota sobre Obligatorio/Opcional: la especificación OpenAPI de origen no declara un array required para este cuerpo de solicitud (solo el cuerpo en su conjunto está marcado como obligatorio). Todos los campos siguientes se muestran como Obligatorios según la convención de documentación de este proyecto y porque cada uno desempeña un papel definido en el flujo de emisión del token — confirma la opcionalidad real con el equipo de ingeniería de DQE antes de publicar.

Campo	Descripción	Tipo	Obl. / Opc.
orgId	El ID de la organización de Salesforce que realiza la solicitud.	String	Obligatorio
crt	La reivindicación de marca de tiempo de creación/emisión para esta solicitud firmada.	String	Obligatorio
sub	La reivindicación de sujeto — el identificador de usuario o sesión de Salesforce que emite la solicitud.	String	Obligatorio
aud	La reivindicación de audiencia — el servicio destinatario/objetivo previsto para esta solicitud firmada.	String	Obligatorio
urllogin	La URL de inicio de sesión de la organización de Salesforce.	String	Obligatorio

Respuesta

Devuelve un objeto JSON que contiene el token de proceso.

Clave	Descripción	Tipo
Token	El token generado, utilizado para autenticar la siguiente llamada del proceso.	String

Ejemplo de respuesta

Ejemplo de respuesta con token

{
  "Token": "token"
}

El único valor de ejemplo de la especificación de origen para Token es la cadena de marcador de posición literal "token" — se muestra tal cual arriba, en lugar de sustituirla por un valor de aspecto inventado.

Errores

La especificación de origen no define ninguna respuesta de error (4xx/5xx) para este endpoint — solo está documentada la respuesta de éxito 200. Confirma el comportamiento real de los errores con el equipo de ingeniería de DQE antes de publicar.

Probar la API

Haz clic en el botón de abajo para probar este endpoint en vivo desde tu navegador.

Abrir consola

Subscription - DQE One API

Registra una organización o usuario de Salesforce y devuelve las credenciales necesarias para las siguientes llamadas autenticadas. Esto parece un flujo de incorporación/registro de la organización, más que un paso de autenticación por llamada.

Jump to Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envía un cuerpo JSON a este endpoint. No se requiere ninguna cabecera de autenticación — la especificación de origen declara un requisito de seguridad vacío para esta ruta.

POSThttps://{DOMAIN}/subscribe

Ejemplos de código

Registrar una organización y obtener credenciales

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/subscribe" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "00D5e0000008abcEAA",
  "groupId": "GRP-00123",
  "licence": "123456",
  "region": "EU",
  "key": "a1b2c3d4e5f6"
}'

fetch("https://{DOMAIN}/subscribe", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    orgId: "00D5e0000008abcEAA",
    groupId: "GRP-00123",
    licence: "123456",
    region: "EU",
    key: "a1b2c3d4e5f6"
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/subscribe",
    json={
        "orgId": "00D5e0000008abcEAA",
        "groupId": "GRP-00123",
        "licence": "123456",
        "region": "EU",
        "key": "a1b2c3d4e5f6",
    },
)
print(response.json())

<?php
$data = [
    'orgId' => '00D5e0000008abcEAA',
    'groupId' => 'GRP-00123',
    'licence' => '123456',
    'region' => 'EU',
    'key' => 'a1b2c3d4e5f6',
];

$ch = curl_init("https://{DOMAIN}/subscribe");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

const axios = require('axios');

axios.post('https://{DOMAIN}/subscribe', {
  orgId: '00D5e0000008abcEAA',
  groupId: 'GRP-00123',
  licence: '123456',
  region: 'EU',
  key: 'a1b2c3d4e5f6'
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"orgId\":\"00D5e0000008abcEAA\",\"groupId\":\"GRP-00123\",\"licence\":\"123456\",\"region\":\"EU\",\"key\":\"a1b2c3d4e5f6\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/subscribe"))
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();

var json = "{\"orgId\":\"00D5e0000008abcEAA\",\"groupId\":\"GRP-00123\",\"licence\":\"123456\",\"region\":\"EU\",\"key\":\"a1b2c3d4e5f6\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

var response = await client.PostAsync("https://{DOMAIN}/subscribe", content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

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

func main() {
    body := []byte(`{"orgId":"00D5e0000008abcEAA","groupId":"GRP-00123","licence":"123456","region":"EU","key":"a1b2c3d4e5f6"}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/subscribe", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parámetros

Todos los campos se envían como un único cuerpo de solicitud JSON.

Nota sobre Obligatorio/Opcional: la especificación OpenAPI de origen no declara un array required para este cuerpo de solicitud (solo el cuerpo en su conjunto está marcado como obligatorio). Todos los campos siguientes se muestran como Obligatorios según la convención de documentación de este proyecto — confirma la opcionalidad real con el equipo de ingeniería de DQE antes de publicar.

Campo	Descripción	Tipo	Obl. / Opc.
orgId	El ID de la organización de Salesforce que se está registrando.	String	Obligatorio
groupId	Identificador del grupo de licencia/instancia de paquete bajo el cual se suscribe esta organización.	String	Obligatorio
licence	El código de licencia de DQE asociado a esta suscripción.	String	Obligatorio
region	La región o centro de datos donde debe aprovisionarse la instancia de DQE de esta organización.	String	Obligatorio
key	Una clave de activación o suscripción utilizada para validar la solicitud de registro. Deducido únicamente a partir del nombre del campo — su finalidad exacta no está documentada en la especificación de origen.	String	Obligatorio

Respuesta

Devuelve un objeto JSON que contiene las credenciales emitidas para esta suscripción.

Clave	Descripción	Tipo
pwd	La contraseña emitida como parte de las nuevas credenciales devueltas por este registro.	String
iss	El identificador de emisor asignado a la organización/usuario recién registrado — se utiliza como parte de las credenciales para las siguientes llamadas autenticadas.	String
issSecret	El secreto asociado al identificador de emisor. Guárdalo de forma segura; autoriza las llamadas posteriores.	String
crt	La marca de tiempo de creación/emisión de estas credenciales.	String
groupId	El identificador de grupo confirmado para esta suscripción (repite el valor de la solicitud).	String

Ejemplo de respuesta

Ejemplo de respuesta de suscripción

{
  "pwd": "a8f3c9d21b47e6f0",
  "iss": "UNIFY-00123",
  "issSecret": "9f86d081884c7d659a2feaa0c55ad015",
  "crt": "2026-10-28T10:15:00Z",
  "groupId": "GRP-00123"
}

La especificación de origen no proporciona valores de example para este esquema. Los valores anteriores son solo marcadores de posición ilustrativos — no se documenta ningún formato o longitud específicos.

Errores

Probar la API

Haz clic en el botón de abajo para probar este endpoint en vivo desde tu navegador.

Abrir consola

Sesión de la interfaz personalizada - API DQE One

Crea un token de sesión para la interfaz personalizada integrada del paquete DQE One, limitado a una sesión y un usuario de Salesforce específicos.

customUI/createTokenSession

Jump to Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envía un cuerpo JSON a este endpoint con la cabecera DQE-Authorization configurada.

POSThttps://{DOMAIN}/customUI/createTokenSession

Ejemplos de código

Crear un token de sesión de la interfaz personalizada

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/customUI/createTokenSession" \
  -H "DQE-Authorization: {DQE_AUTHORIZATION_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
  "orgId": "00D5e0000008abcEAA",
  "aud": "dqe-unify-api",
  "urllogin": "https://login.salesforce.com",
  "sub": "0055e00000AbCnoFAF",
  "name": "Jane Doe",
  "sessionId": "00D5e0000008abcEAA!AQEAQJ3x9fKZ",
  "licence": "123456",
  "region": "EU",
  "isPersonAccountEnable": false,
  "chatterId": "0D55e00000ABCDEFG",
  "setTokenToUi": true
}'

fetch("https://{DOMAIN}/customUI/createTokenSession", {
  method: "POST",
  headers: {
    "DQE-Authorization": "{DQE_AUTHORIZATION_KEY}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    orgId: "00D5e0000008abcEAA",
    aud: "dqe-unify-api",
    urllogin: "https://login.salesforce.com",
    sub: "0055e00000AbCnoFAF",
    name: "Jane Doe",
    sessionId: "00D5e0000008abcEAA!AQEAQJ3x9fKZ",
    licence: "123456",
    region: "EU",
    isPersonAccountEnable: false,
    chatterId: "0D55e00000ABCDEFG",
    setTokenToUi: true
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/customUI/createTokenSession",
    headers={
        "DQE-Authorization": "{DQE_AUTHORIZATION_KEY}",
    },
    json={
        "orgId": "00D5e0000008abcEAA",
        "aud": "dqe-unify-api",
        "urllogin": "https://login.salesforce.com",
        "sub": "0055e00000AbCnoFAF",
        "name": "Jane Doe",
        "sessionId": "00D5e0000008abcEAA!AQEAQJ3x9fKZ",
        "licence": "123456",
        "region": "EU",
        "isPersonAccountEnable": False,
        "chatterId": "0D55e00000ABCDEFG",
        "setTokenToUi": True,
    },
)
print(response.json())

<?php
$data = [
    'orgId' => '00D5e0000008abcEAA',
    'aud' => 'dqe-unify-api',
    'urllogin' => 'https://login.salesforce.com',
    'sub' => '0055e00000AbCnoFAF',
    'name' => 'Jane Doe',
    'sessionId' => '00D5e0000008abcEAA!AQEAQJ3x9fKZ',
    'licence' => '123456',
    'region' => 'EU',
    'isPersonAccountEnable' => false,
    'chatterId' => '0D55e00000ABCDEFG',
    'setTokenToUi' => true,
];

$ch = curl_init("https://{DOMAIN}/customUI/createTokenSession");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'DQE-Authorization: {DQE_AUTHORIZATION_KEY}',
    'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);

$result = json_decode($response, true);

const axios = require('axios');

axios.post('https://{DOMAIN}/customUI/createTokenSession', {
  orgId: '00D5e0000008abcEAA',
  aud: 'dqe-unify-api',
  urllogin: 'https://login.salesforce.com',
  sub: '0055e00000AbCnoFAF',
  name: 'Jane Doe',
  sessionId: '00D5e0000008abcEAA!AQEAQJ3x9fKZ',
  licence: '123456',
  region: 'EU',
  isPersonAccountEnable: false,
  chatterId: '0D55e00000ABCDEFG',
  setTokenToUi: true
}, {
  headers: {
    'DQE-Authorization': '{DQE_AUTHORIZATION_KEY}',
    'Content-Type': 'application/json'
  }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"orgId\":\"00D5e0000008abcEAA\",\"aud\":\"dqe-unify-api\",\"urllogin\":\"https://login.salesforce.com\",\"sub\":\"0055e00000AbCnoFAF\",\"name\":\"Jane Doe\",\"sessionId\":\"00D5e0000008abcEAA!AQEAQJ3x9fKZ\",\"licence\":\"123456\",\"region\":\"EU\",\"isPersonAccountEnable\":false,\"chatterId\":\"0D55e00000ABCDEFG\",\"setTokenToUi\":true}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/customUI/createTokenSession"))
    .header("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

using var client = new HttpClient();

var json = "{\"orgId\":\"00D5e0000008abcEAA\",\"aud\":\"dqe-unify-api\",\"urllogin\":\"https://login.salesforce.com\",\"sub\":\"0055e00000AbCnoFAF\",\"name\":\"Jane Doe\",\"sessionId\":\"00D5e0000008abcEAA!AQEAQJ3x9fKZ\",\"licence\":\"123456\",\"region\":\"EU\",\"isPersonAccountEnable\":false,\"chatterId\":\"0D55e00000ABCDEFG\",\"setTokenToUi\":true}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://{DOMAIN}/customUI/createTokenSession");
request.Headers.Add("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}");
request.Content = content;

var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

package main

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

func main() {
    body := []byte(`{"orgId":"00D5e0000008abcEAA","aud":"dqe-unify-api","urllogin":"https://login.salesforce.com","sub":"0055e00000AbCnoFAF","name":"Jane Doe","sessionId":"00D5e0000008abcEAA!AQEAQJ3x9fKZ","licence":"123456","region":"EU","isPersonAccountEnable":false,"chatterId":"0D55e00000ABCDEFG","setTokenToUi":true}`)

    req, _ := http.NewRequest("POST", "https://{DOMAIN}/customUI/createTokenSession", bytes.NewBuffer(body))
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("DQE-Authorization", "{DQE_AUTHORIZATION_KEY}")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}

Parámetros

Todos los campos se envían como un único cuerpo de solicitud JSON.

Nota sobre Obligatorio/Opcional: la especificación OpenAPI de origen no declara un array required para este cuerpo de solicitud (solo el cuerpo en su conjunto está marcado como obligatorio). Todos los campos siguientes se muestran como Obligatorios según la convención de documentación de este proyecto — confirma la opcionalidad real con el equipo de ingeniería de DQE antes de publicar.

Campo	Descripción	Tipo	Obl. / Opc.
orgId	El ID de la organización de Salesforce que realiza la solicitud.	String	Obligatorio
aud	La reivindicación de audiencia — el servicio destinatario/objetivo previsto para esta solicitud firmada.	String	Obligatorio
urllogin	La URL de inicio de sesión de la organización de Salesforce.	String	Obligatorio
sub	La reivindicación de sujeto — el identificador de usuario o sesión de Salesforce que emite la solicitud.	String	Obligatorio
name	Nombre para mostrar asociado a la sesión (por ejemplo, el nombre del usuario de Salesforce).	String	Obligatorio
sessionId	Identificador de la sesión de Salesforce a la que está vinculado este token de la interfaz personalizada.	String	Obligatorio
licence	El código de licencia de DQE asociado a esta organización.	String	Obligatorio
region	La región o centro de datos de la organización de Salesforce o de la instancia de DQE.	String	Obligatorio
isPersonAccountEnable	Indica si las cuentas personales (Person Accounts) están habilitadas en la organización de Salesforce que realiza la llamada.	Boolean	Obligatorio
chatterId	Identificador de un registro de Salesforce Chatter (por ejemplo, un elemento del feed) asociado a esta sesión. Deducido únicamente a partir del nombre del campo — su finalidad exacta no está documentada en la especificación de origen.	String	Obligatorio
setTokenToUi	Indica si el token generado debe escribirse directamente en la sesión de la interfaz personalizada, en lugar de devolverse únicamente en la respuesta de la API. Deducido únicamente a partir del nombre del campo.	Boolean	Obligatorio

Respuesta

Devuelve un objeto JSON que describe el token de sesión de la interfaz personalizada creado.

Clave	Descripción	Tipo
status	Estado del resultado de la solicitud de creación de la sesión.	String
uuidToken	El token de sesión generado, utilizado para autenticar la sesión de la interfaz personalizada. El nombre del campo sugiere un formato UUID, pero esto no está confirmado por la especificación de origen.	String
name	Repite el nombre de sesión/usuario asociado al token creado.	String
isUiLocal	Indica si la sesión de la interfaz personalizada se está ejecutando en modo local en lugar de contra el entorno alojado de DQE. Deducido únicamente a partir del nombre del campo — no confirmado por la especificación de origen.	Boolean

Ejemplo de respuesta

Ejemplo de respuesta con token de sesión

{
  "status": "success",
  "uuidToken": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Jane Doe",
  "isUiLocal": false
}

La especificación de origen no proporciona valores de example para este esquema. Los valores anteriores son solo marcadores de posición ilustrativos.

API DQE One — Autenticación y sesión

getOAuthTokenForProcess

Solicitud

Ejemplos de código

Parámetros

Respuesta

Ejemplo de respuesta

Errores

Probar la API

subscribe

Solicitud

Ejemplos de código

Parámetros

Respuesta

Ejemplo de respuesta

Errores

Probar la API

customUI/createTokenSession

Solicitud

Ejemplos de código

Parámetros

Respuesta

Ejemplo de respuesta

Errores

Probar la API

Ver también

¿Fue útil este artículo?

Artículo anterior

Artículo siguiente