Endpoints de API e SDK

Consulte a URL correta do dashboard, o endpoint da REST API e o endpoint de SDK para sua instância da Braze. Você precisa dessas URLs para fazer login, realizar chamadas de API e integrar o SDK.

A Braze gerencia diversas instâncias diferentes para nosso dashboard, SDK e endpoints REST, que chamamos de “clusters.” Seu gerente de integração da Braze informará em qual cluster você está. Para saber mais sobre o SDK da Braze, confira o Braze 101, um curso do Braze Learning.

Fazer login em dashboard.braze.com enviará você automaticamente para o endereço correto do cluster.

Importante

Ao integrar seu SDK, use o endpoint de SDK. Ao fazer chamadas para nossa REST API, use o endpoint REST.

Para mais informações sobre como acessar a API, consulte nosso artigo de visão geral da API.

URLs personalizados

Em vez do endpoint de SDK padrão do seu cluster, você pode configurar o SDK da Braze para enviar as solicitações de rede para um URL personalizado, como um proxy ou um domínio personalizado. Os seguintes SDKs oferecem suporte a URLs personalizados:

• SDK Swift da Braze: versão 11.8.0 e posteriores
• SDK Android da Braze: versão 2.11 e posteriores

Configurar um URL personalizado

Defina o URL personalizado no mesmo lugar em que você define o endpoint do SDK ao inicializar o SDK. Para ver todas as etapas de integração, consulte Integrar o SDK da Braze.

• swift
• android

1
2
3
4
5
6

let configuration = Braze.Configuration(
  apiKey: "YOUR_APP_IDENTIFIER_API_KEY",
  endpoint: "YOUR_CUSTOM_URL"
)
let braze = Braze(configuration: configuration)
AppDelegate.braze = braze

1
2
3
4

BRZConfiguration *configuration = [[BRZConfiguration alloc] initWithApiKey:@"YOUR_APP_IDENTIFIER_API_KEY"
                                                                  endpoint:@"YOUR_CUSTOM_URL"];
Braze *braze = [[Braze alloc] initWithConfiguration:configuration];
AppDelegate.braze = braze;

1
2
3
4
5

<?xml version="1.0" encoding="utf-8"?>
<resources>
  <string translatable="false" name="com_braze_api_key">YOUR_APP_IDENTIFIER_API_KEY</string>
  <string translatable="false" name="com_braze_custom_endpoint">YOUR_CUSTOM_URL</string>
</resources>

1
2
3
4
5

BrazeConfig brazeConfig = new BrazeConfig.Builder()
  .setApiKey("YOUR_APP_IDENTIFIER_API_KEY")
  .setCustomEndpoint("YOUR_CUSTOM_URL")
  .build();
Braze.configure(this, brazeConfig);

1
2
3
4
5

val brazeConfig = BrazeConfig.Builder()
  .setApiKey("YOUR_APP_IDENTIFIER_API_KEY")
  .setCustomEndpoint("YOUR_CUSTOM_URL")
  .build()
Braze.configure(this, brazeConfig)

Testar a configuração do proxy

Teste se o seu proxy funciona como esperado antes de lançar o app em produção. Para confirmar que o SDK envia as solicitações para o seu URL personalizado, use o registro detalhado:

1. Ative o registro detalhado na compilação de desenvolvimento antes de inicializar o SDK. Para ver o código de cada SDK, consulte Registro detalhado.
2. Execute o app em um dispositivo de teste ou simulador. O SDK envia uma solicitação quando uma sessão começa.
3. Nos registros, encontre as entradas de solicitação e confirme se o URL da solicitação corresponde ao seu URL personalizado.
4. Confirme se o seu proxy recebe as solicitações do SDK.

Se você não encontrar nenhuma solicitação para o seu URL personalizado no Android, verifique a chave de API e a configuração do endpoint. Para ver exemplos de como as entradas de solicitação aparecem nos registros, consulte Leitura de registros detalhados.

Importante

Desative o registro detalhado antes de lançar o app em produção.