API DQE One — Gestión de la interfaz personalizada

Custom UI Management - DQE One API

La API DQE One es la API de backend expuesta por el paquete DQE One para Salesforce. Los endpoints de Gestión de la interfaz personalizada de esta página restablecen e importan las reglas que rigen la interfaz personalizada integrada del paquete para una sesión determinada.

Diferente de la mayoría de los endpoints de One: ambos endpoints de esta página se autentican con un JWT Bearer estándar en la cabecera Authorization (Authorization: Bearer {JWT_TOKEN}), no con la cabecera de clave de API DQE-Authorization utilizada por la mayoría de los demás endpoints de la API DQE One. Consulta Authentication & Session para saber cómo se emite este token.

Documentación relacionada:

DQE One API — Introduction (resumen del modelo de autenticación, comprobación de disponibilidad)
DQE One API — Authentication & Session (cómo se emite el token Bearer utilizado por estos endpoints, mediante customUI/createTokenSession)

Ir a customUI/resetRules customUI/importRules

Reset Rules - DQE One API

Restablece las reglas de la interfaz personalizada de una sesión de interfaz personalizada determinada a su estado predeterminado.

customUI/resetRules

Ir a Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envía un cuerpo JSON a este endpoint con la cabecera Authorization establecida en un token Bearer.

Diferente de la mayoría de los endpoints de One: este endpoint (y su endpoint hermano, customUI/importRules) se autentica con un JWT Bearer estándar en la cabecera Authorization (Authorization: Bearer {JWT_TOKEN}), no con la cabecera de clave de API DQE-Authorization utilizada por la mayoría de los demás endpoints de la API DQE One. Consulta Authentication & Session para saber cómo se emite este token.

{DOMAIN} es el dominio del servidor donde está instalada la propia instancia 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.

POSThttps://{DOMAIN}/customUI/resetRules

Ejemplos de código

Restablecer las reglas de la interfaz personalizada de una sesión

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/customUI/resetRules" \
  -H "Authorization: Bearer {JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "uuidToken": "550e8400-e29b-41d4-a716-446655440000"
}'

fetch("https://{DOMAIN}/customUI/resetRules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    uuidToken: "550e8400-e29b-41d4-a716-446655440000"
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/customUI/resetRules",
    headers={
        "Authorization": "Bearer {JWT_TOKEN}",
    },
    json={
        "uuidToken": "550e8400-e29b-41d4-a716-446655440000",
    },
)
print(response.json())

<?php
$data = [
    'uuidToken' => '550e8400-e29b-41d4-a716-446655440000',
];

$ch = curl_init("https://{DOMAIN}/customUI/resetRules");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer {JWT_TOKEN}',
    '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/resetRules', {
  uuidToken: '550e8400-e29b-41d4-a716-446655440000'
}, {
  headers: {
    'Authorization': 'Bearer {JWT_TOKEN}',
    'Content-Type': 'application/json'
  }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"uuidToken\":\"550e8400-e29b-41d4-a716-446655440000\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/customUI/resetRules"))
    .header("Authorization", "Bearer {JWT_TOKEN}")
    .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 = "{\"uuidToken\":\"550e8400-e29b-41d4-a716-446655440000\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://{DOMAIN}/customUI/resetRules");
request.Headers.Add("Authorization", "Bearer {JWT_TOKEN}");
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(`{"uuidToken":"550e8400-e29b-41d4-a716-446655440000"}`)

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

    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

All fields are sent as a single JSON request body.

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). El campo siguiente se muestra como Obligatorio 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
uuidToken	Identificador del token de sesión de la interfaz personalizada para el que se restablecen las reglas — el mismo valor de `uuidToken` devuelto por `customUI/createTokenSession` (consulta Authentication & Session).	String	Obligatorio

Respuesta

Devuelve un objeto JSON que confirma el resultado de la operación de restablecimiento.

Clave	Descripción	Tipo
status	Estado del resultado de la operación de restablecimiento.	String

Ejemplo de respuesta

Ejemplo de respuesta de restablecimiento

{
  "status": "success"
}

La especificación de origen no proporciona un valor de example para este esquema. El valor anterior es únicamente un marcador de posición ilustrativo.

Errores

La especificación de origen no define ninguna respuesta de error (4xx/5xx) para este endpoint — solo se documenta 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 en tu navegador.

Abrir consola

Import Rules - DQE One API

Importa un payload de reglas de interfaz personalizada en una sesión de interfaz personalizada determinada.

customUI/importRules

Ir a Parámetros Respuesta Ejemplo Errores ▶ Probar la API

Solicitud

Envía un cuerpo JSON a este endpoint con la cabecera Authorization establecida en un token Bearer.

Diferente de la mayoría de los endpoints de One: este endpoint (y su endpoint hermano, customUI/resetRules) se autentica con un JWT Bearer estándar en la cabecera Authorization (Authorization: Bearer {JWT_TOKEN}), no con la cabecera de clave de API DQE-Authorization utilizada por la mayoría de los demás endpoints de la API DQE One. Consulta Authentication & Session para saber cómo se emite este token.

POSThttps://{DOMAIN}/customUI/importRules

Ejemplos de código

Importar un payload de reglas de interfaz personalizada en una sesión

cURL JavaScript Python PHP Node.js Java C# Go

curl -X POST "https://{DOMAIN}/customUI/importRules" \
  -H "Authorization: Bearer {JWT_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
  "uuidToken": "550e8400-e29b-41d4-a716-446655440000",
  "importRules": "{RULES_PAYLOAD}"
}'

fetch("https://{DOMAIN}/customUI/importRules", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {JWT_TOKEN}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    uuidToken: "550e8400-e29b-41d4-a716-446655440000",
    importRules: "{RULES_PAYLOAD}"
  })
})
  .then(r => r.json())
  .then(data => console.log(data));

import requests

response = requests.post(
    "https://{DOMAIN}/customUI/importRules",
    headers={
        "Authorization": "Bearer {JWT_TOKEN}",
    },
    json={
        "uuidToken": "550e8400-e29b-41d4-a716-446655440000",
        "importRules": "{RULES_PAYLOAD}",
    },
)
print(response.json())

<?php
$data = [
    'uuidToken' => '550e8400-e29b-41d4-a716-446655440000',
    'importRules' => '{RULES_PAYLOAD}',
];

$ch = curl_init("https://{DOMAIN}/customUI/importRules");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer {JWT_TOKEN}',
    '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/importRules', {
  uuidToken: '550e8400-e29b-41d4-a716-446655440000',
  importRules: '{RULES_PAYLOAD}'
}, {
  headers: {
    'Authorization': 'Bearer {JWT_TOKEN}',
    'Content-Type': 'application/json'
  }
})
  .then(response => console.log(response.data));

HttpClient client = HttpClient.newHttpClient();

String body = "{\"uuidToken\":\"550e8400-e29b-41d4-a716-446655440000\",\"importRules\":\"{RULES_PAYLOAD}\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://{DOMAIN}/customUI/importRules"))
    .header("Authorization", "Bearer {JWT_TOKEN}")
    .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 = "{\"uuidToken\":\"550e8400-e29b-41d4-a716-446655440000\",\"importRules\":\"{RULES_PAYLOAD}\"}";
var content = new StringContent(json, Encoding.UTF8, "application/json");

using var request = new HttpRequestMessage(HttpMethod.Post, "https://{DOMAIN}/customUI/importRules");
request.Headers.Add("Authorization", "Bearer {JWT_TOKEN}");
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(`{"uuidToken":"550e8400-e29b-41d4-a716-446655440000","importRules":"{RULES_PAYLOAD}"}`)

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

    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

All fields are sent as a single JSON request body.

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 Obligatorio 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
uuidToken	Identificador del token de sesión de la interfaz personalizada en el que se importan las reglas — el mismo valor de `uuidToken` devuelto por `customUI/createTokenSession` (consulta Authentication & Session).	String	Obligatorio
importRules	El payload de reglas de la interfaz personalizada que se va a importar. La especificación de origen no define el formato esperado de este payload — descrito aquí de forma genérica a la espera de confirmación del equipo de ingeniería de DQE.	String	Obligatorio

Respuesta

Devuelve un objeto JSON que confirma el resultado de la operación de importación.

Clave	Descripción	Tipo
status	Estado del resultado de la operación de importación.	String

Ejemplo de respuesta

Ejemplo de respuesta de importación

{
  "status": "success"
}

La especificación de origen no proporciona un valor de example para este esquema. El valor anterior es únicamente un marcador de posición ilustrativo.

Errores

Probar la API

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

Abrir consola

API DQE One — Gestión de la interfaz personalizada

customUI/resetRules

Solicitud

Ejemplos de código

Parámetros

Respuesta

Ejemplo de respuesta

Errores

Probar la API

customUI/importRules

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