# Acionar jornadas do cliente usando entrada baseada em API

A Entrada baseada em API permite que você inicie uma jornada do cliente no momento em que um evento de negócio específico ocorre. Para iniciar uma campanha, você precisa enviar uma solicitação de API especial.


## Configuração

1. Crie uma jornada com uma Entrada baseada em API

<video src="/customer-journey-api-based-entry-1.webm" alt="Interface do Customer Journey Builder mostrando como criar uma nova jornada com o elemento de Entrada baseada em API" autoplay loop muted playsinline />

2. Clique duas vezes na etapa de Entrada baseada em API. A janela de configuração da Entrada será aberta.

3. Você pode modificar o conteúdo de push e e-mail toda vez que a jornada for iniciada usando placeholders de conteúdo. O valor de cada placeholder pode ser alterado na solicitação. Se você não precisar dessa opção, pode pular esta etapa.

> Por exemplo, você está criando uma jornada para notificar os assinantes quando um novo episódio de podcast é lançado. Usando um placeholder de conteúdo, você pode alterar o título do podcast toda vez que iniciar a jornada.

Primeiro, adicione nomes de placeholders na janela de configuração da Entrada baseada em API. Você pode usar quaisquer nomes que sejam convenientes para você.

<video src="/customer-journey-api-based-entry-2.webm" alt="Janela de configuração da Entrada baseada em API mostrando como adicionar nomes de placeholders para conteúdo dinâmico" autoplay loop muted playsinline />

Agora, crie uma [Predefinição](/pt/product/content/presets/) de push ou e-mail e insira o placeholder no lugar do texto que você deseja modificar. O placeholder deve estar em um dos seguintes formatos, dependendo de suas necessidades:

* `{placeholder_name|format_modifier|}` – se o valor do placeholder não for especificado ao iniciar a campanha, os usuários verão um espaço em branco em seu lugar.
* `{placeholder_name|format_modifier}` – se o valor do placeholder não for especificado e ainda não tiver sido atribuído a um usuário (caso você tenha usado uma Tag como placeholder), a mensagem não será enviada.

<details>

<summary>Modificadores de formato</summary>

* CapitalizeFirst – coloca em maiúscula a primeira letra do valor de um placeholder;
* CapitalizeAllFirst – coloca em maiúscula as primeiras letras de todas as palavras no valor de um placeholder, se o valor consistir em mais de uma palavra;
* UPPERCASE – converte todas as letras para maiúsculas;
* lowercase – converte todas as letras para minúsculas;
* regular – insere o valor de um placeholder exatamente como especificado na solicitação, sem modificações.

</details>

<img src="/customer-journey-api-based-entry-3.webp" alt="Editor de predefinição de Push mostrando um exemplo de sintaxe de placeholder com modificadores de formato no conteúdo da mensagem"/>

<Aside type="note">
Você também pode usar um nome de Tag existente em vez de um nome de placeholder. Nesse caso, você deve configurar a substituição do valor dessa Tag pelo valor especificado na solicitação, conforme descrito abaixo.
</Aside>

Ao configurar a etapa de Push ou E-mail em sua jornada, selecione a predefinição criada e ative a opção **Personalizar mensagem com atributos de evento**. Selecione os placeholders que você deseja modificar na solicitação ao iniciar a jornada. Escolha uma **Entrada baseada em API** como a origem e o nome do placeholder como o atributo dinâmico:

<video src="/customer-journey-api-based-entry-4.webm" title="Configuração da etapa de Push ou E-mail mostrando a opção Personalizar mensagem com atributos de evento e a seleção da origem da Entrada baseada em API" autoplay loop muted playsinline />

Clique em **Aplicar** para salvar as alterações.

4\. Na janela de configuração da Entrada, copie o modelo de solicitação para modificá-lo:

<img src="/customer-journey-api-based-entry-5.webp" alt="Janela de configuração da Entrada baseada em API exibindo o modelo de solicitação de API com o formato do cabeçalho de autorização"/>
<Aside>
Para iniciar uma jornada via API, você deve incluir um token de autorização válido no cabeçalho de Autorização.

**Formato de cabeçalho obrigatório**

 ```http
 Authorization: Api <your_api_token>
 ```
 **Exemplo**

 ```http
 Authorization: Api c8dc6435-xxxxxxxxxxxxxxx
 ```
</Aside>

5. Adicione filtros de público ao parâmetro "filter" usando a [Linguagem de Segmentação](/pt/developer/api-reference/segmentation-filters-api/segmentation-language/). Observe que você precisa configurar as [Tags](/pt/developer/guides/audience-and-segmentation/tags/) necessárias com antecedência.

Por exemplo, se você deseja direcionar a jornada para usuários que adicionaram o item _Socks_ à sua _Wishlist_, o valor de "filter" deve ser o seguinte:

```
    "filter": "A("12345-12345") * "T("Wishlist", EQ, "Socks")"
```

Neste exemplo, você deve ter uma Tag _Wishlist_ configurada em seu aplicativo.

<Aside type="note">
O código do seu aplicativo será adicionado automaticamente ao parâmetro "filter" no formato `A(\"12345-12345\")`. Por favor, não o remova ou modifique.

Além disso, lembre-se de que aspas ("") e barras invertidas (\\) devem ser escapadas com uma barra invertida (\\) em consultas JSON.
</Aside>

6. Se você configurou placeholders, especifique o conteúdo desejado como seus valores:

<img src="/customer-journey-api-based-entry-6.webp" alt="Modelo de solicitação de API mostrando a configuração de valores de placeholder para conteúdo dinâmico no lançamento da jornada"/>

7. Se a opção **Limites de Taxa de Mensagens** estiver ativada, o número de usuários que entram na jornada de uma vez a cada segundo será limitado. Você pode usar o valor padrão de 5000 usuários por segundo ou definir outro número.

<img src="/customer-journey-api-based-entry-7.webp" alt="Configuração da Entrada baseada em API mostrando a opção Limites de Taxa de Mensagens com o valor padrão de 5000 usuários por segundo"/>

<Aside type="tip">
Recomendamos manter o valor entre 5000 e 10000 usuários por segundo. Se o valor for muito baixo, pode levar mais tempo para o seu público entrar na jornada. Se o valor for muito alto, o serviço que processa seus dados pode ficar sobrecarregado.
</Aside>

8. Se você planeja reiniciar sua campanha com frequência e não quer que os mesmos usuários entrem na jornada várias vezes, defina o [Limite de Frequência](/pt/product/customer-journey/journey-settings#frequency-capping).

> Por exemplo, você criou uma campanha para notificar os usuários sobre a redução de preço de um produto específico. Você deseja relançar a jornada algumas vezes, enviando várias solicitações com diferentes filtros de público. Nesse caso, você pode adicionar o Limite de Frequência para que a notificação não seja enviada repetidamente para usuários que correspondem a vários filtros.

9. Se você deseja que uma jornada seja iniciada sempre que um determinado evento de negócio acontecer, automatize a solicitação usando o webhook. Assim que o evento ocorrer, o webhook deve enviar automaticamente a solicitação para iniciar a jornada.

Você também pode enviar a solicitação manualmente se não precisar de automação.

<Aside type="note">
* Se você alterar as condições de segmentação ao enviar uma nova solicitação, isso não afetará os usuários que já entraram na jornada.
* Se você alterar o conteúdo da mensagem ao enviar uma nova solicitação, todos os usuários receberão a nova versão da mensagem (incluindo aqueles que já entraram na jornada, mas ainda não receberam esta mensagem).
</Aside>