Referências, repositórios e aplicativos de amostra
Esta é uma lista da documentação de referência, dos repositórios do GitHub e dos apps de amostra pertencentes a cada SDK do Braze. A documentação de referência de um SDK detalha suas classes, tipos, funções e variáveis disponíveis. Enquanto o repositório do GitHub fornece insight sobre as declarações de função e atribuição do SDK, alterações de código e controle de versão. Cada repositório também inclui aplicativos de amostra totalmente compiláveis que você pode usar para testar os recursos do Braze ou implementar junto com seus próprios aplicativos.
Lista de recursos
Atualmente, alguns SDKs não têm documentação de referência dedicada, mas estamos trabalhando ativamente nisso.
Plataforma | Referência | Repositório | App de amostra |
---|---|---|---|
Android SDK | Documentação de referência | Repositório do GitHub | App de amostra |
SWIFT SDK | Documentação de referência | Repositório do GitHub | App de amostra |
SDK da Web | Documentação de referência | Repositório do GitHub | App de amostra |
Cordova SDK | Arquivo de declaração | Repositório do GitHub | App de amostra |
SDK para Flutter | Documentação de referência | Repositório do GitHub | App de amostra |
React Native SDK | Arquivo de declaração | Repositório do GitHub | App de amostra |
Roku SDK | N/D | Repositório do GitHub | App de amostra |
Unity SDK | Arquivo de declaração | Repositório do GitHub | App de amostra |
SDK do Unreal Engine | N/D | Repositório do GitHub | App de amostra |
Xamarin SDK | N/D | Repositório do GitHub | App de amostra |
Criação de um aplicativo de amostra
Criação do “Droidboy”
Nosso aplicativo de teste no repositório do GitHub do é chamado Droidboy. Siga estas instruções para criar uma cópia totalmente funcional dela em seu projeto.
- Crie um novo espaço de trabalho e note a chave de identificação da API do Braze.
- Copie seu ID de remetente FCM e a chave de identificação da API do Braze nos locais apropriados em
/droidboy/res/values/braze.xml
(entre as tags das strings denominadascom_braze_push_fcm_sender_id
ecom_braze_api_key
, respectivamente). - Copie a chave do servidor FCM e o ID do servidor nas configurações do espaço de trabalho em Gerenciar configurações.
- Para montar o APK do Droidboy, execute
./gradlew assemble
no diretório do SDK. Usegradlew.bat
no Windows. - Para instalar automaticamente o APK do Droidboy em um dispositivo de teste, execute
./gradlew installDebug
no diretório do SDK:
Construindo “Hello Braze” (Olá, Braze)
O aplicativo de teste Hello Braze mostra um caso de uso mínimo do SDK da Braze e, além disso, mostra como integrar facilmente o SDK da Braze em um projeto Gradle.
- Copie sua chave de identificador de API da página Manage Settings em seu arquivo
braze.xml
na pastares/values
. - Para instalar o app de amostra em um dispositivo ou emulador, execute o seguinte comando no diretório do SDK:
1
./gradlew installDebug
Se você não tiver a variável
ANDROID_HOME
definida corretamente ou não tiver uma pastalocal.properties
com uma pastasdk.dir
válida, esse plug-in também instalará o SDK básico para você. Consulte o repositório de plug-ins para obter mais informações.
Para saber mais sobre o sistema de compilação do Android SDK, consulte o LEIAME do repositório do GitHub.
Criação de apps de teste Swift
Siga estas instruções para criar e executar nossos aplicativos de teste.
- Crie um novo espaço de trabalho e note a chave de API do identificador do app e o ponto de extremidade.
- Com base em seu método de integração (Swift Package Manager, CocoaPods, Manual), selecione o arquivo
xcodeproj
apropriado para abrir. - Coloque sua chave de API e seu endpoint no campo apropriado no arquivo
Credentials
.
Ao realizar o controle de qualidade na integração do SDK, use o depurador do SDK para solucionar problemas sem ativar o registro detalhado do seu aplicativo.