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."
}API para obter a personalização de marca (branding)
Consulte o branding white-label da sua aplicação pela Management API da Didit: cores, fontes, bordas, URLs do logo e opções de UI do fluxo.
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
Retorna a identidade visual white-label da aplicação identificada pela sua chave de API, a mesma exibida aos usuários finais no fluxo de verificação. A resposta inclui cores, fontes, raios de borda, URLs de logotipos e opções de UI/UX.Quando usar
- Ler o tema atual: obtenha a paleta, as fontes e os logotipos ativos antes de exibi-los ou editá-los.
- Sincronizar a identidade visual: replique a identidade visual da Didit na sua própria interface administrativa.
Observações
- A aplicação é identificada pela chave de API, portanto não há parâmetros de caminho nem de consulta.
logo_square,logo_rectangular,logo_rectangular_dark,faviconefont_urlsão somente para leitura. Defina os logotipos enviando imagens em Atualizar identidade visual.logo_rectangular_darké o logotipo retangular para o modo escuro, exibido sobre fundo escuro. Ele énullquando nenhum logotipo escuro foi definido ou quando os logotipos retangulares não são exibidos para a sua conta.- O domínio personalizado e o e-mail de marca própria não fazem parte desta resposta; eles continuam sendo gerenciados no Business Console.
Permissões
A chave de API precisa ter permissão para ler a personalização da aplicação.Relacionados
Autorizações
Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.
Resposta
Personalização de marca atual da aplicação.
Identidade visual de marca própria de uma aplicação: cores, fontes, raios, URLs de logotipo e opções de UI/UX. As URLs de logotipo são somente leitura (defina-as enviando imagens). Domínio personalizado e e-mail de marca própria não estão incluídos.
Somente leitura. URL resolvida da folha de estilo do Google Fonts para a família selecionada.
URL somente leitura do logotipo quadrado. Envie via image_square.
URL somente leitura do logotipo retangular. Envie via image_rectangular.
Somente leitura. URL assinada temporária do logotipo retangular para o modo escuro, exibido sobre fundo escuro. null quando nenhum logotipo escuro está definido ou quando logotipos retangulares não são exibidos para a sua conta. Envie-o com image_rectangular_dark.
URL somente leitura do favicon. Envie via image_favicon.