Endpoints API et SDK

Recherchez l’URL correcte du tableau de bord, l’endpoint REST API et l’endpoint SDK pour votre instance Braze. Vous avez besoin de ces URL pour vous connecter, effectuer des appels API et intégrer le SDK.

Braze gère un certain nombre d’instances différentes pour notre tableau de bord, notre SDK et nos endpoints REST, que nous appelons « clusters ». Votre gestionnaire d’onboarding Braze vous indiquera sur quel cluster vous vous trouvez. Pour en savoir plus sur le SDK Braze, consultez le cours d’apprentissage Braze Learning Braze 101.

Se connecter sur dashboard.braze.com vous redirige automatiquement vers la bonne adresse de cluster.

Important

Lors de l’intégration de votre SDK, utilisez l’endpoint SDK. Lors d’appels à notre REST API, utilisez l’endpoint REST.

Pour plus de détails sur l’accès à l’API, consultez notre article d’aperçu de l’API.

URL personnalisées

Au lieu de l’endpoint SDK standard de votre cluster, vous pouvez configurer le SDK de Braze pour qu’il envoie ses requêtes réseau vers une URL personnalisée, comme un proxy ou un domaine personnalisé. Les SDK suivants prennent en charge les URL personnalisées :

• SDK Swift de Braze : version 11.8.0 et ultérieures
• SDK Android de Braze : version 2.11 et ultérieures

Configurer une URL personnalisée

Définissez votre URL personnalisée à l’endroit où vous définissez l’endpoint de votre SDK lors de son initialisation. Pour connaître toutes les étapes d’intégration, consultez Intégrer le SDK de 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)

Tester la configuration de votre proxy

Vérifiez que votre proxy fonctionne comme prévu avant de publier votre application en production. Pour confirmer que le SDK envoie bien ses requêtes vers votre URL personnalisée, utilisez la journalisation détaillée :

1. Activez la journalisation détaillée dans votre version de développement avant d’initialiser le SDK. Pour obtenir le code correspondant à chaque SDK, consultez Journalisation détaillée.
2. Exécutez votre application sur un appareil de test ou un simulateur. Le SDK envoie une requête au démarrage d’une session.
3. Dans vos journaux, repérez les entrées de requête et vérifiez que l’URL de la requête correspond à votre URL personnalisée.
4. Vérifiez que votre proxy reçoit bien les requêtes du SDK.

Si vous ne voyez aucune requête vers votre URL personnalisée sur Android, vérifiez votre clé API et la configuration de votre endpoint. Pour voir des exemples d’entrées de requête dans les journaux, consultez Lire les journaux détaillés.

Important

Désactivez la journalisation détaillée avant de publier votre application en production.