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."
}Obter API de Personalização de Marca
Obtenha a marca white-label da sua aplicação via API de Gestão da Didit: cores, tipos de letra, raios, URLs de logótipos e opções de UI.
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."
}Visão geral
Devolve o branding de marca branca da aplicação identificada pela sua chave de API, ou seja, a mesma identidade visual apresentada aos utilizadores finais no fluxo de verificação. A resposta inclui cores, tipos de letra, raios das bordas, URLs dos logótipos e opções de UI/UX.Quando utilizar
- Ler o tema atual: obtenha a paleta, o tipo de letra e os logótipos ativos antes de os apresentar ou editar.
- Sincronizar a identidade visual: replique a identidade visual da Didit na sua própria interface de administração.
Notas
- A aplicação é identificada a partir da chave de API. Não existem parâmetros de caminho ou de consulta.
logo_square,logo_rectangular,logo_rectangular_dark,faviconefont_urlsão apenas de leitura. Defina os logótipos carregando imagens em Atualizar a identidade visual.logo_rectangular_darké o logótipo retangular para o modo escuro, apresentado sobre um fundo escuro. Tem o valornullquando não está definido nenhum logótipo escuro ou quando os logótipos retangulares não são apresentados na sua conta.- O domínio personalizado e o e-mail de marca branca não fazem parte desta resposta; continuam a ser geridos na Business Console.
Permissões
A chave de API tem de poder ler a personalização da aplicação.Conteúdo relacionado
Autorizações
A chave de API da sua aplicação, a partir de Programadores -> Chaves de API na Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs como nulos, e uma chave sem permissão de escrita em sessões recebe ligações de sessão e tokens como nulos. Consulte https://docs.didit.me/console/api-keys.
Resposta
Personalização de marca atual para a aplicação.
Personalização de marca branca para uma aplicação: cores, tipos de letra, raios, URLs do logótipo e opções de UI/UX. Os URLs do logótipo são apenas de leitura (defina-os carregando imagens). O domínio personalizado e o e-mail de marca branca não estão incluídos.
Apenas de leitura. URL resolvido da folha de estilos do Google Fonts para a família selecionada.
URL apenas de leitura do logótipo quadrado. Carregue através de image_square.
URL apenas de leitura do logótipo retangular. Carregue através de image_rectangular.
Apenas de leitura. URL assinado temporário do logótipo retangular para o modo escuro, apresentado num fundo escuro. null quando nenhum logótipo escuro estiver definido ou logótipos retangulares não forem apresentados para a sua conta. Carregue-o com image_rectangular_dark.
URL apenas de leitura do favicon. Carregue através de image_favicon.