curl -X GET 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.customization.retrieve()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.customization.retrieve();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Customization.Retrieve(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.customization().retrieve();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->customization->retrieve();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.customization.retrieve
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Customization.RetrieveAsync();
Console.WriteLine(JsonSerializer.Serialize(result));{
"color_primary": "#000000",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 12,
"font_family": "Inter",
"font_weight": "regular",
"font_url": "https://fonts.googleapis.com/css2?family=Inter",
"logo_square": null,
"logo_rectangular": null,
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": false,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}{
"detail": "You do not have permission to perform this action."
}Récupérer le branding via l'API de personnalisation
Lisez le branding en marque blanche de votre application via l’API de gestion Didit : couleurs, polices, rayons, logos et options d’interface.
curl -X GET 'https://verification.didit.me/v3/customization/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.customization.retrieve()
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.customization.retrieve();
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Customization.Retrieve(ctx)
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.customization().retrieve();
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->customization->retrieve();
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.customization.retrieve
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Customization.RetrieveAsync();
Console.WriteLine(JsonSerializer.Serialize(result));{
"color_primary": "#000000",
"color_secondary": "#9DA1A1",
"color_background": "#FFFFFF",
"color_panel": "#2567FF",
"color_panel_10": "#1A1A1A",
"color_on_panel_1": "#9DA1A1",
"color_on_panel_2": "#F4F4F6",
"color_on_background": "#000000",
"color_button_1": "#2567FF",
"color_button_2": "#F8F8F8",
"color_button_text_1": "#FFFFFF",
"color_button_text_2": "#000000",
"color_pill_text": "#111827",
"border_radius_panel": 10,
"border_radius_buttons": 12,
"font_family": "Inter",
"font_weight": "regular",
"font_url": "https://fonts.googleapis.com/css2?family=Inter",
"logo_square": null,
"logo_rectangular": null,
"logo_rectangular_dark": null,
"favicon": null,
"app_public_name": "Acme Verify",
"privacy_policy_url": "https://acme.com/privacy",
"skip_welcome_screen": false,
"disable_login_with_didit": false,
"hide_progress_bar": false,
"callback_seconds": 3
}{
"detail": "You do not have permission to perform this action."
}Vue d’ensemble
Renvoie l’identité visuelle en marque blanche de l’application identifiée par votre clé API, soit la même identité visuelle que celle affichée aux utilisateurs finaux dans le parcours de vérification. La réponse couvre les couleurs, les polices, les rayons de bordure, les URL des logos et les options d’interface utilisateur et d’expérience utilisateur.Quand l’utiliser
- Lire le thème actuel : récupérer la palette, la police et les logos actifs avant de les afficher ou de les modifier.
- Synchroniser l’identité visuelle : reproduire l’identité visuelle de Didit dans votre propre interface d’administration.
Notes
- L’application est identifiée à partir de la clé API : il n’existe aucun paramètre de chemin ni de requête.
logo_square,logo_rectangular,logo_rectangular_dark,faviconetfont_urlsont en lecture seule. Pour définir les logos, téléversez des images dans Mettre à jour l’identité visuelle.logo_rectangular_darkest le logo rectangulaire pour le mode sombre, affiché sur un fond sombre. Il vautnulllorsqu’aucun logo sombre n’est défini ou lorsque les logos rectangulaires ne sont pas affichés pour votre compte.- Le domaine personnalisé et l’e-mail en marque blanche ne font pas partie de cette réponse ; ils restent gérés dans la Business Console.
Autorisations
La clé API doit pouvoir lire la personnalisation de l’application.Voir aussi
Autorisations
La clé API de votre application, issue de Développeurs -> Clés API dans la Business Console. La clé principale dispose d'un accès complet. Une clé nommée peut être restreinte : aucun, lecture ou écriture par ressource, limitée à certains workflows ou aux sessions approuvées, à une liste d'adresses IP et à une date d'expiration. 401 signifie que la clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a été envoyée, que la clé n'a pas accès à cette ressource ou action, ou que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur une route de session signifie que la session est hors des workflows ou des statuts de la clé. Une clé sans accès aux médias reçoit les URL d'images, de vidéos et de PDF à null, et une clé sans accès en écriture aux sessions reçoit les liens et tokens de session à null. Voir https://docs.didit.me/console/api-keys.
Réponse
Personnalisation actuelle de l'image de marque pour l'application.
Personnalisation en marque blanche pour une application : couleurs, polices, arrondis, URL des logos et options UI/UX. Les URL des logos sont en lecture seule (définissez-les en téléversant des images). Le domaine personnalisé et l'e-mail en marque blanche ne sont pas inclus.
Lecture seule. URL résolue de la feuille de style Google Fonts pour la famille sélectionnée.
URL en lecture seule du logo carré. Téléversez via image_square.
URL en lecture seule du logo rectangulaire. Téléversez via image_rectangular.
Lecture seule. URL signée temporaire du logo rectangulaire pour le mode sombre, affiché sur fond sombre. Vaut null lorsqu'aucun logo sombre n'est configuré ou que les logos rectangulaires ne sont pas affichés pour votre compte. Téléversez-le avec image_rectangular_dark.
URL en lecture seule du favicon. Téléversez via image_favicon.