O node ASE Client permite criar, consultar e atualizar as informações dos clientes na plataforma Appointment Scheduling Enterprise (ASE). Para utilizá-lo, acesse o Studio e procure o node ASE Client dentro da categoria Appointment Scheduling Enterprise.
Configuração do node
A seguir, você encontrará a descrição dos campos disponíveis para configurar o node:
1. Name (opcional): permite personalizar o nome do node dentro do fluxo, substituindo o valor padrão.
2. Credentials (obrigatório): permite selecionar as credenciais do serviço Engageware Appointment Scheduling Enterprise. Você pode salvar várias credenciais, mas apenas uma pode estar ativa.
Para configurá-las, você deverá informar os seguintes dados:
- Instance URL: URL do ambiente.
- Username: nome de usuário para o consumo da API.
- Password: senha correspondente ao usuário da API.
3. Action (obrigatório): define o tipo de operação que o node realizará. Você pode selecionar as seguintes opções:
Search: permite consultar as informações de um cliente específico por meio dos seguintes critérios de busca:
- Client External Id (string): identificador externo atribuído ao cliente durante sua criação. Permite buscar clientes cujo ID corresponda ao valor informado.
- First Name (string): nome do cliente.
- Last Name (string): sobrenome do cliente.
- User Name (string): nome de usuário do cliente.
- Email Address (string): endereço de e-mail de contato do cliente.
- ClientExternalId: identificador do cliente no Appointment Scheduling Enterprise. Pode ser qualquer cadeia de texto se for informado ao criar o cliente. Caso contrário, o sistema gerará um automaticamente.
- Phone Number (string): número de telefone de contato do cliente.
- Exact Match Only (boolean): define se a busca deve corresponder exatamente aos dados informados.
- Modified Since (dateTime): permite filtrar os clientes pela data a partir da qual foram modificados.
Create / Update: permite criar um cliente ou atualizar as informações de um cliente existente.
Para essas operações, você encontrará os seguintes campos:
- ClientExternalId: identificador do cliente no Appointment Scheduling Enterprise. Pode ser qualquer cadeia de texto se for informado durante a criação. Caso contrário, o sistema gerará um automaticamente.
- Client properties: contém as propriedades que serão armazenadas ao criar o cliente ou atualizadas se o cliente já existir.
Outputs
Os resultados de cada operação estarão disponíveis nas seguintes propriedades do objeto msg:
1. Create: msg.payload.metadata.EW_ASE_CreateClientResponse
Se a criação for realizada com sucesso, a propriedade status retornará o valor 0.
Em caso de erro, será retornado: msg.payload.metadata.EW_ASE_CreateClientResponse.error
2. Get: msg.payload.metadata.EW_ASE_GetClientResponse
Se a consulta for realizada com sucesso, as informações do cliente serão retornadas.
Em caso de erro, será retornado: msg.payload.metadata.EW_ASE_GetClientResponse.error
3. Update: msg.payload.metadata.EW_ASE_UpdateClientResponse
Se a atualização for realizada com sucesso, a propriedade status retornará o valor 0.
Em caso de erro, será retornado: msg.payload.metadata.EW_ASE_UpdateClientResponse.error
Você pode baixar um fluxo de exemplo neste link.
No vídeo a seguir, mostramos como configurar o node: