Disparar uma sincronização
/cdi/integrations/{integration_id}/sync
Use este endpoint para iniciar uma sincronização para uma determinada integração imediatamente, por exemplo, quando o carregamento do seu data warehouse terminar. Sincronizações sob demanda são executadas além de qualquer cronograma recorrente e não o alteram. Se uma sincronização já estiver em execução para a integração, a solicitação retornará
429.
Para usar este endpoint, você deve gerar uma chave de API com a permissão cdi.integration_sync.
Limite de frequência
Esse endpoint tem um limite de frequência de 20 solicitações por minuto.
Parâmetros de caminho
| Parâmetro | Obrigatório | Tipo de dados | Descrição |
|---|---|---|---|
integration_id |
Obrigatório | String | ID de integração. Isso é encontrado na URL ao visualizar uma integração no dashboard da Braze. O formato da URL é https://[instance].braze.com/integrations/cloud_data_ingestion/[integration_id]. |
Exemplo de solicitação
curl --location --request POST 'https://rest.iad-03.braze.com/cdi/integrations/00000000-0000-0000-0000-000000000000/sync' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
Resposta
Exemplo de resposta bem-sucedida
O código de status 202 pode retornar o seguinte corpo de resposta:
{
"message": "success"
}
Solução de problemas
A tabela a seguir lista os possíveis erros retornados e as etapas de solução de problemas associadas.
| Erro | Solução de problemas |
|---|---|
400 Invalid integration ID |
Verifique se o integration_id é válido. |
404 Integration not found |
Não existe integração para o ID de integração fornecido. Certifique-se de que seu ID de integração é válido. |
429 Another job is in progress |
Há uma sincronização em execução para esta integração. Tente novamente após a sincronização ser concluída. |
Para códigos de status adicionais e mensagens de erro associadas, consulte Erros fatais e respostas.