API DQE One — Gestion de l'interface personnalisée

Gestion de l'interface personnalisée - API DQE One

L'API DQE One est l'API backend exposée par le package DQE One pour Salesforce. Les endpoints de Gestion de l'interface personnalisée sur cette page réinitialisent et importent les règles qui pilotent l'interface personnalisée intégrée du package pour une session donnée.

Différent de la plupart des endpoints One : les deux endpoints de cette page s'authentifient avec un JWT Bearer standard dans l'en-tête Authorization (Authorization: Bearer {JWT_TOKEN}), et non l'en-tête API-key DQE-Authorization utilisé par la plupart des autres endpoints de l'API DQE One. Voir Authentification et session pour savoir comment ce jeton est émis.

Documentation associée :

API DQE One — Introduction (aperçu du modèle d'authentification, vérification de disponibilité)
API DQE One — Authentification et session (comment le jeton Bearer utilisé par ces endpoints est émis, via customUI/createTokenSession)

Aller à customUI/resetRules customUI/importRules

Réinitialisation des règles - API DQE One

Réinitialise les règles de l'interface personnalisée d'une session donnée à leur état par défaut.

customUI/resetRules

Aller à Paramètres Réponse Exemple Erreurs ▶ Test the API

Requête

Envoyez un corps JSON à cet endpoint avec l'en-tête Authorization défini sur un jeton Bearer.

Différent de la plupart des endpoints One : cet endpoint (ainsi que son équivalent, customUI/importRules) s'authentifie avec un JWT Bearer standard dans l'en-tête Authorization (Authorization: Bearer {JWT_TOKEN}), et non l'en-tête API-key DQE-Authorization utilisé par la plupart des autres endpoints de l'API DQE One. Voir Authentification et session pour savoir comment ce jeton est émis.

{DOMAIN} est le domaine du serveur où votre instance du backend DQE One est installée — comme ce backend fonctionne dans votre propre infrastructure, cette valeur est déterminée par votre déploiement, elle n'est pas fournie par DQE.

POSThttps://{DOMAIN}/customUI/resetRules

Exemples de code

Réinitialiser les règles de l'interface personnalisée d'une session

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))
}

Paramètres

Tous les champs sont envoyés dans un seul corps de requête JSON.

Note sur Obligatoire/Optionnel : la spécification OpenAPI source ne déclare pas de tableau required pour ce corps de requête (seul le corps dans son ensemble est marqué comme obligatoire). Le champ ci-dessous est indiqué comme Obligatoire selon la convention de documentation de ce projet — confirmer l'optionnalité réelle avec l'équipe d'ingénierie DQE avant publication.

Champ	Description	Type	Obl / Opt
uuidToken	Identifiant du jeton de session de l'interface personnalisée pour lequel réinitialiser les règles — la même valeur `uuidToken` que celle renvoyée par `customUI/createTokenSession` (voir Authentification et session).	String	Mandatory

Réponse

Renvoie un objet JSON confirmant le résultat de l'opération de réinitialisation.

Key	Description	Type
status	Statut du résultat de l'opération de réinitialisation.	String

Exemple de réponse

Exemple de réponse de réinitialisation

{
  "status": "success"
}

La spécification source ne fournit aucune valeur example pour ce schéma. La valeur ci-dessus est un simple exemple illustratif.

Erreurs

La spécification source ne définit aucune réponse d'erreur (4xx/5xx) pour cet endpoint — seule la réponse de succès 200 est documentée. Confirmer le comportement réel des erreurs avec l'équipe d'ingénierie DQE avant publication.

Tester l'API

Cliquez sur le bouton ci-dessous pour tester cet endpoint en direct dans votre navigateur.

Ouvrir la console

Importation des règles - API DQE One

Importe un payload de règles d'interface personnalisée dans une session donnée.

customUI/importRules

Aller à Paramètres Réponse Exemple Erreurs ▶ Test the API

Requête

Envoyez un corps JSON à cet endpoint avec l'en-tête Authorization défini sur un jeton Bearer.

Différent de la plupart des endpoints One : cet endpoint (ainsi que son équivalent, customUI/resetRules) s'authentifie avec un JWT Bearer standard dans l'en-tête Authorization (Authorization: Bearer {JWT_TOKEN}), et non l'en-tête API-key DQE-Authorization utilisé par la plupart des autres endpoints de l'API DQE One. Voir Authentification et session pour savoir comment ce jeton est émis.

POSThttps://{DOMAIN}/customUI/importRules

Exemples de code

Importer un payload de règles d'interface personnalisée dans une session

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))
}

Paramètres

Tous les champs sont envoyés dans un seul corps de requête JSON.

Note sur Obligatoire/Optionnel : la spécification OpenAPI source ne déclare pas de tableau required pour ce corps de requête (seul le corps dans son ensemble est marqué comme obligatoire). Tous les champs ci-dessous sont indiqués comme Obligatoires selon la convention de documentation de ce projet — confirmer l'optionnalité réelle avec l'équipe d'ingénierie DQE avant publication.

Champ	Description	Type	Obl / Opt
uuidToken	Identifiant du jeton de session de l'interface personnalisée dans lequel importer les règles — la même valeur `uuidToken` que celle renvoyée par `customUI/createTokenSession` (voir Authentification et session).	String	Mandatory
importRules	Le payload de règles d'interface personnalisée à importer. La spécification source ne définit pas le format attendu de ce payload — décrit ici de façon générique, en attente de confirmation par l'équipe d'ingénierie DQE.	String	Mandatory

Réponse

Renvoie un objet JSON confirmant le résultat de l'opération d'importation.

Key	Description	Type
status	Statut du résultat de l'opération d'importation.	String

Exemple de réponse

Exemple de réponse d'importation

{
  "status": "success"
}

La spécification source ne fournit aucune valeur example pour ce schéma. La valeur ci-dessus est un simple exemple illustratif.

Erreurs

Tester l'API

Cliquez sur le bouton ci-dessous pour tester cet endpoint en direct dans votre navigateur.

Ouvrir la console

API DQE One — Gestion de l'interface personnalisée

customUI/resetRules

Requête

Exemples de code

Paramètres

Réponse

Exemple de réponse

Erreurs

Tester l'API

customUI/importRules

Requête

Exemples de code

Paramètres

Réponse

Exemple de réponse

Erreurs

Tester l'API

Voir aussi

Cet article vous a-t-il été utile ?

Article précédent

Article suivant